Index
A
- AgentHeaderDescriptor — Class in namespace Google\ApiCore
- Encapsulates the custom GAPIC header information.
- ApiException — Class in namespace Google\ApiCore
- Represents an exception thrown during an RPC.
- ApiStatus — Class in namespace Google\ApiCore
- ArrayTrait — Class in namespace Google\ApiCore
- Provides basic array helper methods.
- $Parser#accept — Property in class Parser
- $ParserAction#action — Property in class ParserAction
- $ParserCachedAction#action — Property in class ParserCachedAction
- $ParserState#actions — Property in class ParserState
- ParserSymbol::addAction() — Method in class ParserSymbol
- AgentHeaderMiddleware — Class in namespace Google\ApiCore\Middleware
- Middleware which configures headers for the request.
- GeneratedTest::assertProtobufEquals() — Method in class GeneratedTest
- MockStubTrait::addResponse() — Method in class MockStubTrait
- Add a response object, and an optional status, to the list of responses to be returned via _simpleRequest.
- Advice — Class in namespace Google\Api
- Generated advice about this change, used for providing more information about how a change will affect the existing service.
- AuthProvider — Class in namespace Google\Api
- Configuration for an anthentication provider, including support for JSON Web Token (JWT).
- AuthRequirement — Class in namespace Google\Api
- User-defined authentication requirements, including support for JSON Web Token (JWT).
- Authentication — Class in namespace Google\Api
Authenticationdefines the authentication configuration for an API.- AuthenticationRule — Class in namespace Google\Api
- Authentication rules for the service.
- AuthorizationConfig — Class in namespace Google\Api
- Configuration of authorization.
- AuditLog — Class in namespace Google\Cloud\Audit
- Common audit log format for Google Cloud Platform API operations.
- AuthenticationInfo — Class in namespace Google\Cloud\Audit
- Authentication information for the operation.
- AuthorizationInfo — Class in namespace Google\Cloud\Audit
- Authorization information for the operation.
- AppProfile — Class in namespace Google\Cloud\Bigtable\Admin\V2
- A configuration object describing how Cloud Bigtable should treat traffic from a particular end user application.
- AppProfile_MultiClusterRoutingUseAny — Class in namespace Google\Cloud\Bigtable\Admin\V2
- Read/write requests may be routed to any cluster in the instance, and will fail over to another cluster in the event of transient errors or delays.
- AppProfile_SingleClusterRouting — Class in namespace Google\Cloud\Bigtable\Admin\V2
- Unconditionally routes all read/write requests to a specific cluster.
- AcceleratorConfig — Class in namespace Google\Cloud\Container\V1
- AcceleratorConfig represents a Hardware Accelerator request.
- AddonsConfig — Class in namespace Google\Cloud\Container\V1
- Configuration for the addons that can be automatically spun up in the cluster, enabling additional functionality.
- AutoUpgradeOptions — Class in namespace Google\Cloud\Container\V1
- AutoUpgradeOptions defines the set of options for the user to control how the Auto Upgrades will proceed.
- AcceleratorConfig — Class in namespace Google\Cloud\Dataproc\V1
- Specifies the type and number of accelerator cards attached to the instances of an instance group (see GPUs on Compute Engine).
- AliasContext — Class in namespace Google\Cloud\DevTools\Source\V1
- An alias to a repo revision.
- AliasContext_Kind — Class in namespace Google\Cloud\DevTools\Source\V1
- The type of an Alias.
- Agent — Class in namespace Google\Cloud\Dialogflow\V2
- Represents a conversational agent.
- Agent_MatchMode — Class in namespace Google\Cloud\Dialogflow\V2
- Match mode determines how intents are detected from user queries.
- AgentsGrpcClient — Class in namespace Google\Cloud\Dialogflow\V2
- Agents are best described as Natural Language Understanding (NLU) modules that transform user requests into actionable data. You can include agents in your app, product, or service to determine user intent and respond to the user in a natural way.
- AudioEncoding — Class in namespace Google\Cloud\Dialogflow\V2
- Audio encoding of the audio content sent in the conversational query request.
- $ExportAgentResponse#agent — Property in class ExportAgentResponse
- $ImportAgentRequest#agent — Property in class ImportAgentRequest
- $RestoreAgentRequest#agent — Property in class RestoreAgentRequest
- Action — Class in namespace Google\Cloud\Dlp\V2
- A task to execute on the completion of a job.
- $Action#action — Property in class Action
- Action_PublishSummaryToCscc — Class in namespace Google\Cloud\Dlp\V2
- Publish the result summary of a DlpJob to the Cloud Security Command Center (CSCC Alpha).
- Action_PublishToPubSub — Class in namespace Google\Cloud\Dlp\V2
- Publish the results of a DlpJob to a pub sub channel.
- Action_SaveFindings — Class in namespace Google\Cloud\Dlp\V2
- If set, the detailed findings will be persisted to the specified OutputStorageConfig. Only a single instance of this action can be specified.
- AnalyzeDataSourceRiskDetails — Class in namespace Google\Cloud\Dlp\V2
- Result of a risk analysis operation request.
- AnalyzeDataSourceRiskDetails_CategoricalStatsResult — Class in namespace Google\Cloud\Dlp\V2
- Result of the categorical stats computation.
- AnalyzeDataSourceRiskDetails_CategoricalStatsResult_CategoricalStatsHistogramBucket — Class in namespace Google\Cloud\Dlp\V2
- Generated from protobuf message
google.privacy.dlp.v2.AnalyzeDataSourceRiskDetails.CategoricalStatsResult.CategoricalStatsHistogramBucket - AnalyzeDataSourceRiskDetails_KAnonymityResult — Class in namespace Google\Cloud\Dlp\V2
- Result of the k-anonymity computation.
- AnalyzeDataSourceRiskDetails_KAnonymityResult_KAnonymityEquivalenceClass — Class in namespace Google\Cloud\Dlp\V2
- The set of columns' values that share the same ldiversity value
- AnalyzeDataSourceRiskDetails_KAnonymityResult_KAnonymityHistogramBucket — Class in namespace Google\Cloud\Dlp\V2
- Generated from protobuf message
google.privacy.dlp.v2.AnalyzeDataSourceRiskDetails.KAnonymityResult.KAnonymityHistogramBucket - AnalyzeDataSourceRiskDetails_KMapEstimationResult — Class in namespace Google\Cloud\Dlp\V2
- Result of the reidentifiability analysis. Note that these results are an estimation, not exact values.
- AnalyzeDataSourceRiskDetails_KMapEstimationResult_KMapEstimationHistogramBucket — Class in namespace Google\Cloud\Dlp\V2
- A KMapEstimationHistogramBucket message with the following values: min_anonymity: 3 max_anonymity: 5 frequency: 42 means that there are 42 records whose quasi-identifier values correspond to 3, 4 or 5 people in the overlying population. An important particular case is when min_anonymity = max_anonymity = 1: the frequency field then corresponds to the number of uniquely identifiable records.
- AnalyzeDataSourceRiskDetails_KMapEstimationResult_KMapEstimationQuasiIdValues — Class in namespace Google\Cloud\Dlp\V2
- A tuple of values for the quasi-identifier columns.
- AnalyzeDataSourceRiskDetails_LDiversityResult — Class in namespace Google\Cloud\Dlp\V2
- Result of the l-diversity computation.
- AnalyzeDataSourceRiskDetails_LDiversityResult_LDiversityEquivalenceClass — Class in namespace Google\Cloud\Dlp\V2
- The set of columns' values that share the same ldiversity value.
- AnalyzeDataSourceRiskDetails_LDiversityResult_LDiversityHistogramBucket — Class in namespace Google\Cloud\Dlp\V2
- Generated from protobuf message
google.privacy.dlp.v2.AnalyzeDataSourceRiskDetails.LDiversityResult.LDiversityHistogramBucket - AnalyzeDataSourceRiskDetails_NumericalStatsResult — Class in namespace Google\Cloud\Dlp\V2
- Result of the numerical stats computation.
- $CryptoReplaceFfxFpeConfig#alphabet — Property in class CryptoReplaceFfxFpeConfig
- $CustomInfoType_DetectionRule_LikelihoodAdjustment#adjustment — Property in class CustomInfoType_DetectionRule_LikelihoodAdjustment
- ArrayValue — Class in namespace Google\Cloud\Firestore\V1beta1
- An array value.
- AnalyzeEntitiesRequest — Class in namespace Google\Cloud\Language\V1beta2
- The entity analysis request message.
- AnalyzeEntitiesResponse — Class in namespace Google\Cloud\Language\V1beta2
- The entity analysis response message.
- AnalyzeEntitySentimentRequest — Class in namespace Google\Cloud\Language\V1beta2
- The entity-level sentiment analysis request message.
- AnalyzeEntitySentimentResponse — Class in namespace Google\Cloud\Language\V1beta2
- The entity-level sentiment analysis response message.
- AnalyzeSentimentRequest — Class in namespace Google\Cloud\Language\V1beta2
- The sentiment analysis request message.
- AnalyzeSentimentResponse — Class in namespace Google\Cloud\Language\V1beta2
- The sentiment analysis response message.
- AnalyzeSyntaxRequest — Class in namespace Google\Cloud\Language\V1beta2
- The syntax analysis request message.
- AnalyzeSyntaxResponse — Class in namespace Google\Cloud\Language\V1beta2
- The syntax analysis response message.
- AnnotateTextRequest — Class in namespace Google\Cloud\Language\V1beta2
- The request message for the text annotation API, which can perform multiple analysis types (sentiment, entities, and syntax) in one call.
- AnnotateTextRequest_Features — Class in namespace Google\Cloud\Language\V1beta2
- All available features for sentiment, syntax, and semantic analysis.
- AnnotateTextResponse — Class in namespace Google\Cloud\Language\V1beta2
- The text annotations response message.
- LanguageServiceGrpcClient::AnalyzeSentiment() — Method in class LanguageServiceGrpcClient
- Analyzes the sentiment of the provided text.
- LanguageServiceGrpcClient::AnalyzeEntities() — Method in class LanguageServiceGrpcClient
- Finds named entities (currently proper names and common nouns) in the text along with entity types, salience, mentions for each entity, and other properties.
- LanguageServiceGrpcClient::AnalyzeEntitySentiment() — Method in class LanguageServiceGrpcClient
- Finds entities, similar to [AnalyzeEntities][google.cloud.language.v1beta2.LanguageService.AnalyzeEntities] in the text and analyzes sentiment associated with each entity and its mentions.
- LanguageServiceGrpcClient::AnalyzeSyntax() — Method in class LanguageServiceGrpcClient
- Analyzes the syntax of the text and provides sentence boundaries and tokenization along with part of speech tags, dependency trees, and other properties.
- LanguageServiceGrpcClient::AnnotateText() — Method in class LanguageServiceGrpcClient
- A convenience method that provides all syntax, sentiment, entity, and classification features in one call.
- Aggregation — Class in namespace Google\Cloud\Monitoring\V3
- Describes how to combine multiple time series to provide different views of
the data. Aggregation consists of an alignment step on individual time
series (
alignment_periodandper_series_aligner) followed by an optional reduction step of the data across the aligned time series (cross_series_reducerandgroup_by_fields). For more details, see Aggregation. - Aggregation_Aligner — Class in namespace Google\Cloud\Monitoring\V3
- The Aligner describes how to bring the data points in a single time series into temporal alignment.
- Aggregation_Reducer — Class in namespace Google\Cloud\Monitoring\V3
- A Reducer describes how to aggregate data points from multiple time series into a single time series.
- AlertPolicy — Class in namespace Google\Cloud\Monitoring\V3
- A description of the conditions under which some aspect of your system is considered to be "unhealthy" and the ways to notify people or services about this state. For an overview of alert policies, see Introduction to Alerting.
- AlertPolicyServiceGrpcClient — Class in namespace Google\Cloud\Monitoring\V3
- The AlertPolicyService API is used to manage (list, create, delete, edit) alert policies in Stackdriver Monitoring. An alerting policy is a description of the conditions under which some aspect of your system is considered to be "unhealthy" and the ways to notify people or services about this state. In addition to using this API, alert policies can also be managed through Stackdriver Monitoring, which can be reached by clicking the "Monitoring" tab in Cloud Console.
- AlertPolicy_Condition — Class in namespace Google\Cloud\Monitoring\V3
- A condition is a true/false test that determines when an alerting policy should open an incident. If a condition evaluates to true, it signifies that something is wrong.
- AlertPolicy_ConditionCombinerType — Class in namespace Google\Cloud\Monitoring\V3
- Operators for combining conditions.
- AlertPolicy_Condition_MetricAbsence — Class in namespace Google\Cloud\Monitoring\V3
- A condition type that checks that monitored resources
are reporting data. The configuration defines a metric and
a set of monitored resources. The predicate is considered in violation
when a time series for the specified metric of a monitored
resource does not include any data in the specified
duration. - AlertPolicy_Condition_MetricThreshold — Class in namespace Google\Cloud\Monitoring\V3
- A condition type that compares a collection of time series against a threshold.
- AlertPolicy_Condition_Trigger — Class in namespace Google\Cloud\Monitoring\V3
- Specifies how many time series must fail a predicate to trigger a
condition. If not specified, then a
{count: 1}trigger is used. - AlertPolicy_Documentation — Class in namespace Google\Cloud\Monitoring\V3
- A content string and a MIME type that describes the content string's format.
- AcknowledgeRequest — Class in namespace Google\Cloud\PubSub\V1
- Request for the Acknowledge method.
- SubscriberGrpcClient::Acknowledge() — Method in class SubscriberGrpcClient
- Acknowledges the messages associated with the
ack_idsin theAcknowledgeRequest. The Pub/Sub system can remove the relevant messages from the subscription. - $RecognitionAudio#audio_source — Property in class RecognitionAudio
- AsyncRecognizeMetadata — Class in namespace Google\Cloud\Speech\V1beta1
- Describes the progress of a long-running
AsyncRecognizecall. It is included in themetadatafield of theOperationreturned by theGetOperationcall of thegoogle::longrunning::Operationsservice. - AsyncRecognizeRequest — Class in namespace Google\Cloud\Speech\V1beta1
- The top-level message sent by the client for the
AsyncRecognizemethod. - AsyncRecognizeResponse — Class in namespace Google\Cloud\Speech\V1beta1
- The only message returned to the client by
AsyncRecognize. It contains the result as zero or more sequentialSpeechRecognitionResultmessages. It is included in theresult.responsefield of theOperationreturned by theGetOperationcall of thegoogle::longrunning::Operationsservice. - $RecognitionAudio#audio_source — Property in class RecognitionAudio
- SpeechGrpcClient::AsyncRecognize() — Method in class SpeechGrpcClient
- Performs asynchronous speech recognition: receive results via the
[google.longrunning.Operations]
(/speech/reference/rest/v1beta1/operations#Operation)
interface. Returns either an
Operation.erroror anOperation.responsewhich contains anAsyncRecognizeResponsemessage. - $RecognitionAudio#audio_source — Property in class RecognitionAudio
- AcknowledgeTaskRequest — Class in namespace Google\Cloud\Tasks\V2beta2
- Request message for acknowledging a task using [AcknowledgeTask][google.cloud.tasks.v2beta2.CloudTasks.AcknowledgeTask].
- AppEngineHttpRequest — Class in namespace Google\Cloud\Tasks\V2beta2
- App Engine HTTP request.
- AppEngineHttpTarget — Class in namespace Google\Cloud\Tasks\V2beta2
- App Engine HTTP target.
- AppEngineRouting — Class in namespace Google\Cloud\Tasks\V2beta2
- App Engine Routing.
- AttemptStatus — Class in namespace Google\Cloud\Tasks\V2beta2
- The status of a task attempt.
- CloudTasksGrpcClient::AcknowledgeTask() — Method in class CloudTasksGrpcClient
- Acknowledges a pull task.
- AttributeValue — Class in namespace Google\Cloud\Trace\V2
- The allowed types for [VALUE] in a
[KEY]:[VALUE]attribute. - AnnotateVideoProgress — Class in namespace Google\Cloud\VideoIntelligence\V1
- Video annotation progress. Included in the
metadatafield of theOperationreturned by theGetOperationcall of thegoogle::longrunning::Operationsservice. - AnnotateVideoRequest — Class in namespace Google\Cloud\VideoIntelligence\V1
- Video annotation request.
- AnnotateVideoResponse — Class in namespace Google\Cloud\VideoIntelligence\V1
- Video annotation response. Included in the
responsefield of theOperationreturned by theGetOperationcall of thegoogle::longrunning::Operationsservice. - VideoIntelligenceServiceGrpcClient::AnnotateVideo() — Method in class VideoIntelligenceServiceGrpcClient
- Performs asynchronous video annotation. Progress and results can be
retrieved through the
google.longrunning.Operationsinterface. - AnnotateVideoProgress — Class in namespace Google\Cloud\VideoIntelligence\V1beta1
- Video annotation progress. Included in the
metadatafield of theOperationreturned by theGetOperationcall of thegoogle::longrunning::Operationsservice. - AnnotateVideoRequest — Class in namespace Google\Cloud\VideoIntelligence\V1beta1
- Video annotation request.
- AnnotateVideoResponse — Class in namespace Google\Cloud\VideoIntelligence\V1beta1
- Video annotation response. Included in the
responsefield of theOperationreturned by theGetOperationcall of thegoogle::longrunning::Operationsservice. - VideoIntelligenceServiceGrpcClient::AnnotateVideo() — Method in class VideoIntelligenceServiceGrpcClient
- Performs asynchronous video annotation. Progress and results can be
retrieved through the
google.longrunning.Operationsinterface. - AnnotateVideoProgress — Class in namespace Google\Cloud\VideoIntelligence\V1beta2
- Video annotation progress. Included in the
metadatafield of theOperationreturned by theGetOperationcall of thegoogle::longrunning::Operationsservice. - AnnotateVideoRequest — Class in namespace Google\Cloud\VideoIntelligence\V1beta2
- Video annotation request.
- AnnotateVideoResponse — Class in namespace Google\Cloud\VideoIntelligence\V1beta2
- Video annotation response. Included in the
responsefield of theOperationreturned by theGetOperationcall of thegoogle::longrunning::Operationsservice. - VideoIntelligenceServiceGrpcClient::AnnotateVideo() — Method in class VideoIntelligenceServiceGrpcClient
- Performs asynchronous video annotation. Progress and results can be
retrieved through the
google.longrunning.Operationsinterface. - AnnotateFileResponse — Class in namespace Google\Cloud\Vision\V1
- Response to a single file annotation request. A file may contain one or more images, which individually have their own responses.
- AnnotateImageRequest — Class in namespace Google\Cloud\Vision\V1
- Request for performing Google Cloud Vision API tasks over a user-provided image, with user-requested features.
- AnnotateImageResponse — Class in namespace Google\Cloud\Vision\V1
- Response to an image annotation request.
- AsyncAnnotateFileRequest — Class in namespace Google\Cloud\Vision\V1
- An offline file annotation request.
- AsyncAnnotateFileResponse — Class in namespace Google\Cloud\Vision\V1
- The response for a single offline file annotation request.
- AsyncBatchAnnotateFilesRequest — Class in namespace Google\Cloud\Vision\V1
- Multiple async file annotation requests are batched into a single service call.
- AsyncBatchAnnotateFilesResponse — Class in namespace Google\Cloud\Vision\V1
- Response to an async batch file annotation request.
- ImageAnnotatorGrpcClient::AsyncBatchAnnotateFiles() — Method in class ImageAnnotatorGrpcClient
- Run asynchronous image detection and annotation for a list of generic
files, such as PDF files, which may contain multiple pages and multiple
images per page. Progress and results can be retrieved through the
google.longrunning.Operationsinterface. - AuditData — Class in namespace Google\Iam\V1\Logging
- Audit log information specific to Cloud IAM. This message is serialized
as an
Anytype in theServiceDatamessage of anAuditLogmessage.
B
- BidiStream — Class in namespace Google\ApiCore
- BidiStream is the response object from a gRPC bidirectional streaming API call.
- CredentialsWrapper::build() — Method in class CredentialsWrapper
- Factory method to create a CredentialsWrapper from an array of options.
- Parser::begin() — Method in class Parser
- RequestBuilder::build() — Method in class RequestBuilder
- GrpcTransport::build() — Method in class GrpcTransport
- Builds a GrpcTransport.
- RestTransport::build() — Method in class RestTransport
- Builds a RestTransport.
- UriTrait::buildUriWithQuery() — Method in class UriTrait
- Backend — Class in namespace Google\Api
Backenddefines the backend configuration for a service.- BackendRule — Class in namespace Google\Api
- A backend rule provides configuration for an individual API element.
- Billing — Class in namespace Google\Api
- Billing related configuration of the service.
- Billing_BillingDestination — Class in namespace Google\Api
- Configuration of a specific billing destination (Currently only support bill against consumer project).
- BigtableInstanceAdminGrpcClient — Class in namespace Google\Cloud\Bigtable\Admin\V2
- Service for creating, configuring, and deleting Cloud Bigtable Instances and Clusters. Provides access to the Instance and Cluster schemas only, not the tables' metadata or data stored in those tables.
- BigtableTableAdminGrpcClient — Class in namespace Google\Cloud\Bigtable\Admin\V2
- Service for creating, configuring, and deleting Cloud Bigtable tables.
- BigtableGrpcClient — Class in namespace Google\Cloud\Bigtable\V2
- Service for reading from and writing to existing Bigtable tables.
- Breakpoint — Class in namespace Google\Cloud\Debugger\V2
- Represents the breakpoint specification, status and results.
- Breakpoint_Action — Class in namespace Google\Cloud\Debugger\V2
- Actions that can be taken when a breakpoint hits.
- Breakpoint_LogLevel — Class in namespace Google\Cloud\Debugger\V2
- Log severity levels.
- BatchCreateEntitiesRequest — Class in namespace Google\Cloud\Dialogflow\V2
- The request message for [EntityTypes.BatchCreateEntities][google.cloud.dialogflow.v2.EntityTypes.BatchCreateEntities].
- BatchDeleteEntitiesRequest — Class in namespace Google\Cloud\Dialogflow\V2
- The request message for [EntityTypes.BatchDeleteEntities][google.cloud.dialogflow.v2.EntityTypes.BatchDeleteEntities].
- BatchDeleteEntityTypesRequest — Class in namespace Google\Cloud\Dialogflow\V2
- The request message for [EntityTypes.BatchDeleteEntityTypes][google.cloud.dialogflow.v2.EntityTypes.BatchDeleteEntityTypes].
- BatchDeleteIntentsRequest — Class in namespace Google\Cloud\Dialogflow\V2
- The request message for [Intents.BatchDeleteIntents][google.cloud.dialogflow.v2.Intents.BatchDeleteIntents].
- BatchUpdateEntitiesRequest — Class in namespace Google\Cloud\Dialogflow\V2
- The response message for [EntityTypes.BatchCreateEntities][google.cloud.dialogflow.v2.EntityTypes.BatchCreateEntities].
- BatchUpdateEntityTypesRequest — Class in namespace Google\Cloud\Dialogflow\V2
- The request message for [EntityTypes.BatchUpdateEntityTypes][google.cloud.dialogflow.v2.EntityTypes.BatchUpdateEntityTypes].
- BatchUpdateEntityTypesResponse — Class in namespace Google\Cloud\Dialogflow\V2
- The response message for [EntityTypes.BatchUpdateEntityTypes][google.cloud.dialogflow.v2.EntityTypes.BatchUpdateEntityTypes].
- BatchUpdateIntentsRequest — Class in namespace Google\Cloud\Dialogflow\V2
- The request message for [Intents.BatchUpdateIntents][google.cloud.dialogflow.v2.Intents.BatchUpdateIntents].
- BatchUpdateIntentsResponse — Class in namespace Google\Cloud\Dialogflow\V2
- The response message for [Intents.BatchUpdateIntents][google.cloud.dialogflow.v2.Intents.BatchUpdateIntents].
- EntityTypesGrpcClient::BatchUpdateEntityTypes() — Method in class EntityTypesGrpcClient
- Updates/Creates multiple entity types in the specified agent.
- EntityTypesGrpcClient::BatchDeleteEntityTypes() — Method in class EntityTypesGrpcClient
- Deletes entity types in the specified agent.
- EntityTypesGrpcClient::BatchCreateEntities() — Method in class EntityTypesGrpcClient
- Creates multiple new entities in the specified entity type (extends the existing collection of entries).
- EntityTypesGrpcClient::BatchUpdateEntities() — Method in class EntityTypesGrpcClient
- Updates entities in the specified entity type (replaces the existing collection of entries).
- EntityTypesGrpcClient::BatchDeleteEntities() — Method in class EntityTypesGrpcClient
- Deletes entities in the specified entity type.
- IntentsGrpcClient::BatchUpdateIntents() — Method in class IntentsGrpcClient
- Updates/Creates multiple intents in the specified agent.
- IntentsGrpcClient::BatchDeleteIntents() — Method in class IntentsGrpcClient
- Deletes intents in the specified agent.
- BigQueryKey — Class in namespace Google\Cloud\Dlp\V2
- Row key for identifying a record in BigQuery table.
- BigQueryOptions — Class in namespace Google\Cloud\Dlp\V2
- Options defining BigQuery table and row identifiers.
- BigQueryOptions_SampleMethod — Class in namespace Google\Cloud\Dlp\V2
- How to sample rows if not all rows are scanned. Meaningful only when used in conjunction with rows_limit. If not specified, scanning would start from the top.
- BigQueryTable — Class in namespace Google\Cloud\Dlp\V2
- Message defining the location of a BigQuery table. A table is uniquely
identified by its project_id, dataset_id, and table_name. Within a query
a table is often referenced with a string in the format of:
<project_id>:<dataset_id>.<table_id>or<project_id>.<dataset_id>.<table_id>. - BoundingBox — Class in namespace Google\Cloud\Dlp\V2
- Bounding box encompassing detected text within an image.
- BucketingConfig — Class in namespace Google\Cloud\Dlp\V2
- Generalization function that buckets values based on ranges. The ranges and replacement values are dynamically provided by the user for custom behavior, such as 1-30 -> LOW 31-65 -> MEDIUM 66-100 -> HIGH This can be used on data of type: number, long, string, timestamp.
- BucketingConfig_Bucket — Class in namespace Google\Cloud\Dlp\V2
- Bucket is represented as a range, along with replacement values.
- ByteContentItem — Class in namespace Google\Cloud\Dlp\V2
- Container for bytes to inspect or redact.
- ByteContentItem_BytesType — Class in namespace Google\Cloud\Dlp\V2
- Protobuf enum
Google\Privacy\Dlp\V2\ByteContentItem\BytesType - BatchGetDocumentsRequest — Class in namespace Google\Cloud\Firestore\V1beta1
- The request for [Firestore.BatchGetDocuments][google.firestore.v1beta1.Firestore.BatchGetDocuments].
- BatchGetDocumentsResponse — Class in namespace Google\Cloud\Firestore\V1beta1
- The streamed response for [Firestore.BatchGetDocuments][google.firestore.v1beta1.Firestore.BatchGetDocuments].
- BeginTransactionRequest — Class in namespace Google\Cloud\Firestore\V1beta1
- The request for [Firestore.BeginTransaction][google.firestore.v1beta1.Firestore.BeginTransaction].
- BeginTransactionResponse — Class in namespace Google\Cloud\Firestore\V1beta1
- The response for [Firestore.BeginTransaction][google.firestore.v1beta1.Firestore.BeginTransaction].
- FirestoreGrpcClient::BatchGetDocuments() — Method in class FirestoreGrpcClient
- Gets multiple documents.
- FirestoreGrpcClient::BeginTransaction() — Method in class FirestoreGrpcClient
- Starts a new transaction.
- Binding — Class in namespace Google\Cloud\Iam\V1
- Associates
memberswith arole. - BindingDelta — Class in namespace Google\Cloud\Iam\V1
- One delta entry for Binding. Each individual change (only one member in each entry) to a binding will be a separate entry.
- BindingDelta_Action — Class in namespace Google\Cloud\Iam\V1
- The type of action performed on a Binding in a policy.
- BeginTransactionRequest — Class in namespace Google\Cloud\Spanner\V1
- The request for [BeginTransaction][google.spanner.v1.Spanner.BeginTransaction].
- SpannerGrpcClient::BeginTransaction() — Method in class SpannerGrpcClient
- Begins a new transaction. This step can often be skipped: [Read][google.spanner.v1.Spanner.Read], [ExecuteSql][google.spanner.v1.Spanner.ExecuteSql] and [Commit][google.spanner.v1.Spanner.Commit] can begin a new transaction as a side-effect.
- BatchWriteSpansRequest — Class in namespace Google\Cloud\Trace\V2
- The request message for the
BatchWriteSpansmethod. - TraceServiceGrpcClient::BatchWriteSpans() — Method in class TraceServiceGrpcClient
- Sends new spans to new or existing traces. You cannot update existing spans.
- BoundingBox — Class in namespace Google\Cloud\VideoIntelligence\V1beta1
- Bounding box.
- BatchAnnotateImagesRequest — Class in namespace Google\Cloud\Vision\V1
- Multiple image annotation requests are batched into a single service call.
- BatchAnnotateImagesResponse — Class in namespace Google\Cloud\Vision\V1
- Response to a batch image annotation request.
- Block — Class in namespace Google\Cloud\Vision\V1
- Logical element on the page.
- Block_BlockType — Class in namespace Google\Cloud\Vision\V1
- Type of a block (text, image etc) as identified by OCR.
- BoundingPoly — Class in namespace Google\Cloud\Vision\V1
- A bounding polygon for the detected image annotation.
- ImageAnnotatorGrpcClient::BatchAnnotateImages() — Method in class ImageAnnotatorGrpcClient
- Run image detection and annotation for a batch of images.
- BadRequest — Class in namespace Google\Rpc
- Describes violations in a client request. This error type focuses on the syntactic aspects of the request.
- BadRequest_FieldViolation — Class in namespace Google\Rpc
- A message type used to describe a single bad request field.
C
- ApiException::createFromStdClass() — Method in class ApiException
- ApiException::createFromApiResponse() — Method in class ApiException
- BidiStream::closeWrite() — Method in class BidiStream
- Inform the server that no more requests will be written. The write() function cannot be called after closeWrite() is called.
- BidiStream::closeWriteAndReadAll() — Method in class BidiStream
- Call closeWrite(), and read all responses from the server, until the streaming call is completed. Throws an ApiException if the streaming call failed.
- Call — Class in namespace Google\ApiCore
- Contains information necessary to manage a network request.
- ClientStream — Class in namespace Google\ApiCore
- ClientStream is the response object from a gRPC client streaming API call.
- CredentialsWrapper — Class in namespace Google\ApiCore
- The CredentialsWrapper object provides a wrapper around a FetchAuthTokenInterface.
- GapicClientTrait::close() — Method in class GapicClientTrait
- Initiates an orderly shutdown in which preexisting calls continue but new calls are immediately cancelled.
- $Parser#conditionStack — Property in class Parser
- $Parser#conditionStackCount — Property in class Parser
- $Parser#conditions — Property in class Parser
- Parser::currentRules() — Method in class Parser
- OperationsGapicClient::cancelOperation() — Method in class OperationsGapicClient
- Starts asynchronous cancellation on a long-running operation. The server
makes a best effort to cancel the operation, but success is not
guaranteed. If the server doesn't support this method, it returns
google.rpc.Code.UNIMPLEMENTED. Clients can use [Operations.GetOperation][google.longrunning.Operations.GetOperation] or other methods to check whether the cancellation succeeded or whether the operation completed despite cancellation. On successful cancellation, the operation is not deleted; instead, it becomes an operation with an [Operation.error][google.longrunning.Operation.error] value with a [google.rpc.Status.code][google.rpc.Status.code] of 1, corresponding toCode.CANCELLED. - CredentialsWrapperMiddleware — Class in namespace Google\ApiCore\Middleware
- Middleware which adds a CredentialsWrapper object to the call options.
- OperationResponse::cancel() — Method in class OperationResponse
- Starts asynchronous cancellation on a long-running operation. The server makes a best effort to cancel the operation, but success is not guaranteed. If the server doesn't support this method, it will throw an ApiException with code \Google\Rpc\Code::UNIMPLEMENTED. Clients can continue to use reload and pollUntilComplete methods to check whether the cancellation succeeded or whether the operation completed despite cancellation.
- PageStreamingDescriptor::createFromFields() — Method in class PageStreamingDescriptor
- PathTemplate::count() — Method in class PathTemplate
- RetrySettings::constructDefault() — Method in class RetrySettings
- $MockStatus#code — Property in class MockStatus
- MockStubTrait::create() — Method in class MockStubTrait
- MockStubTrait::createWithResponseSequence() — Method in class MockStubTrait
- Creates a sequence such that the responses are returned in order.
- MockTransport::close() — Method in class MockTransport
- Closes the connection, if one exists.
- RestTransport::close() — Method in class RestTransport
- Closes the connection, if one exists.
- TransportInterface::close() — Method in class TransportInterface
- Closes the connection, if one exists.
- ChangeType — Class in namespace Google\Api
- Classifies set of possible modifications to an object in the service configuration.
- ConfigChange — Class in namespace Google\Api
- Output generated from semantically comparing two versions of a service configuration.
- Context — Class in namespace Google\Api
Contextdefines which contexts an API requests.- ContextRule — Class in namespace Google\Api
- A context rule provides information about the context for an individual API element.
- Control — Class in namespace Google\Api
- Selects and configures the service controller used by the service. The service controller handles features like abuse, quota, billing, logging, monitoring, etc.
- CustomHttpPattern — Class in namespace Google\Api
- A custom pattern is used for defining custom HTTP verb.
- CheckValidCredsRequest — Class in namespace Google\Cloud\BigQuery\DataTransfer\V1
- A request to determine whether the user has valid credentials. This method is used to limit the number of OAuth popups in the user interface. The user id is inferred from the API call context.
- CheckValidCredsResponse — Class in namespace Google\Cloud\BigQuery\DataTransfer\V1
- A response indicating whether the credentials exist and are valid.
- CreateTransferConfigRequest — Class in namespace Google\Cloud\BigQuery\DataTransfer\V1
- A request to create a data transfer configuration. If new credentials are needed for this transfer configuration, an authorization code must be provided. If an authorization code is provided, the transfer configuration will be associated with the user id corresponding to the authorization code. Otherwise, the transfer configuration will be associated with the calling user.
- DataTransferServiceGrpcClient::CreateTransferConfig() — Method in class DataTransferServiceGrpcClient
- Creates a new data transfer configuration.
- DataTransferServiceGrpcClient::CheckValidCreds() — Method in class DataTransferServiceGrpcClient
- Returns true if valid credentials exist for the given data source and requesting user.
- BigtableInstanceAdminGrpcClient::CreateInstance() — Method in class BigtableInstanceAdminGrpcClient
- Create an instance within a project.
- BigtableInstanceAdminGrpcClient::CreateCluster() — Method in class BigtableInstanceAdminGrpcClient
- Creates a cluster within an instance.
- BigtableInstanceAdminGrpcClient::CreateAppProfile() — Method in class BigtableInstanceAdminGrpcClient
- Creates an app profile within an instance.
- BigtableTableAdminGrpcClient::CreateTable() — Method in class BigtableTableAdminGrpcClient
- Creates a new table in the specified instance.
- BigtableTableAdminGrpcClient::CreateTableFromSnapshot() — Method in class BigtableTableAdminGrpcClient
- Creates a new table from the specified snapshot. The target table must not exist. The snapshot and the table must be in the same instance.
- BigtableTableAdminGrpcClient::CheckConsistency() — Method in class BigtableTableAdminGrpcClient
- Checks replication consistency based on a consistency token, that is, if replication has caught up based on the conditions specified in the token and the check request.
- CheckConsistencyRequest — Class in namespace Google\Cloud\Bigtable\Admin\V2
- Request message for [google.bigtable.admin.v2.BigtableTableAdmin.CheckConsistency][google.bigtable.admin.v2.BigtableTableAdmin.CheckConsistency]
- CheckConsistencyResponse — Class in namespace Google\Cloud\Bigtable\Admin\V2
- Response message for [google.bigtable.admin.v2.BigtableTableAdmin.CheckConsistency][google.bigtable.admin.v2.BigtableTableAdmin.CheckConsistency]
- Cluster — Class in namespace Google\Cloud\Bigtable\Admin\V2
- A resizable group of nodes in a particular cloud location, capable of serving all [Tables][google.bigtable.admin.v2.Table] in the parent [Instance][google.bigtable.admin.v2.Instance].
- Cluster_State — Class in namespace Google\Cloud\Bigtable\Admin\V2
- Possible states of a cluster.
- ColumnFamily — Class in namespace Google\Cloud\Bigtable\Admin\V2
- A set of columns within a table which share a common configuration.
- CreateAppProfileRequest — Class in namespace Google\Cloud\Bigtable\Admin\V2
- Request message for BigtableInstanceAdmin.CreateAppProfile.
- CreateClusterMetadata — Class in namespace Google\Cloud\Bigtable\Admin\V2
- The metadata for the Operation returned by CreateCluster.
- CreateClusterRequest — Class in namespace Google\Cloud\Bigtable\Admin\V2
- Request message for BigtableInstanceAdmin.CreateCluster.
- CreateInstanceMetadata — Class in namespace Google\Cloud\Bigtable\Admin\V2
- The metadata for the Operation returned by CreateInstance.
- CreateInstanceRequest — Class in namespace Google\Cloud\Bigtable\Admin\V2
- Request message for BigtableInstanceAdmin.CreateInstance.
- CreateTableFromSnapshotMetadata — Class in namespace Google\Cloud\Bigtable\Admin\V2
- The metadata for the Operation returned by CreateTableFromSnapshot.
- CreateTableFromSnapshotRequest — Class in namespace Google\Cloud\Bigtable\Admin\V2
- Request message for [google.bigtable.admin.v2.BigtableTableAdmin.CreateTableFromSnapshot][google.bigtable.admin.v2.BigtableTableAdmin.CreateTableFromSnapshot] Note: This is a private alpha release of Cloud Bigtable snapshots. This feature is not currently available to most Cloud Bigtable customers. This feature might be changed in backward-incompatible ways and is not recommended for production use. It is not subject to any SLA or deprecation policy.
- CreateTableRequest — Class in namespace Google\Cloud\Bigtable\Admin\V2
- Request message for [google.bigtable.admin.v2.BigtableTableAdmin.CreateTable][google.bigtable.admin.v2.BigtableTableAdmin.CreateTable]
- CreateTableRequest_Split — Class in namespace Google\Cloud\Bigtable\Admin\V2
- An initial split point for a newly created table.
- BigtableGrpcClient::CheckAndMutateRow() — Method in class BigtableGrpcClient
- Mutates a row atomically based on the output of a predicate Reader filter.
- Cell — Class in namespace Google\Cloud\Bigtable\V2
- Specifies (some of) the contents of a single row/column/timestamp of a table.
- CheckAndMutateRowRequest — Class in namespace Google\Cloud\Bigtable\V2
- Request message for Bigtable.CheckAndMutateRow.
- CheckAndMutateRowResponse — Class in namespace Google\Cloud\Bigtable\V2
- Response message for Bigtable.CheckAndMutateRow.
- Column — Class in namespace Google\Cloud\Bigtable\V2
- Specifies (some of) the contents of a single row/column intersection of a table.
- ColumnRange — Class in namespace Google\Cloud\Bigtable\V2
- Specifies a contiguous range of columns within a single column family.
- CancelOperationRequest — Class in namespace Google\Cloud\Container\V1
- CancelOperationRequest cancels a single operation.
- ClientCertificateConfig — Class in namespace Google\Cloud\Container\V1
- Configuration for client certificates on the cluster.
- Cluster — Class in namespace Google\Cloud\Container\V1
- A Google Container Engine cluster.
- ClusterManagerGrpcClient — Class in namespace Google\Cloud\Container\V1
- Google Container Engine Cluster Manager v1
- ClusterManagerGrpcClient::CreateCluster() — Method in class ClusterManagerGrpcClient
- Creates a cluster, consisting of the specified number and type of Google Compute Engine instances.
- ClusterManagerGrpcClient::CancelOperation() — Method in class ClusterManagerGrpcClient
- Cancels the specified operation.
- ClusterManagerGrpcClient::CreateNodePool() — Method in class ClusterManagerGrpcClient
- Creates a node pool for a cluster.
- ClusterManagerGrpcClient::CompleteIPRotation() — Method in class ClusterManagerGrpcClient
- Completes master IP rotation.
- ClusterUpdate — Class in namespace Google\Cloud\Container\V1
- ClusterUpdate describes an update to the cluster. Exactly one update can be applied to a cluster with each request, so at most one field can be provided.
- Cluster_Status — Class in namespace Google\Cloud\Container\V1
- The current status of the cluster.
- CompleteIPRotationRequest — Class in namespace Google\Cloud\Container\V1
- CompleteIPRotationRequest moves the cluster master back into single-IP mode.
- CreateClusterRequest — Class in namespace Google\Cloud\Container\V1
- CreateClusterRequest creates a cluster.
- CreateNodePoolRequest — Class in namespace Google\Cloud\Container\V1
- CreateNodePoolRequest creates a node pool for a cluster.
- CancelJobRequest — Class in namespace Google\Cloud\Dataproc\V1
- A request to cancel a job.
- Cluster — Class in namespace Google\Cloud\Dataproc\V1
- Describes the identifying information, config, and status of a cluster of Google Compute Engine instances.
- ClusterConfig — Class in namespace Google\Cloud\Dataproc\V1
- The cluster config.
- ClusterControllerGrpcClient — Class in namespace Google\Cloud\Dataproc\V1
- The ClusterControllerService provides methods to manage clusters of Google Compute Engine instances.
- ClusterControllerGrpcClient::CreateCluster() — Method in class ClusterControllerGrpcClient
- Creates a cluster in a project.
- ClusterMetrics — Class in namespace Google\Cloud\Dataproc\V1
- Contains cluster daemon metrics, such as HDFS and YARN stats.
- ClusterOperationMetadata — Class in namespace Google\Cloud\Dataproc\V1
- Metadata describing the operation.
- ClusterOperationStatus — Class in namespace Google\Cloud\Dataproc\V1
- The status of the operation.
- ClusterOperationStatus_State — Class in namespace Google\Cloud\Dataproc\V1
- The operation state.
- ClusterStatus — Class in namespace Google\Cloud\Dataproc\V1
- The status of a cluster and its instances.
- ClusterStatus_State — Class in namespace Google\Cloud\Dataproc\V1
- The cluster state.
- ClusterStatus_Substate — Class in namespace Google\Cloud\Dataproc\V1
- Protobuf enum
Google\Cloud\Dataproc\V1\ClusterStatus\Substate - CreateClusterRequest — Class in namespace Google\Cloud\Dataproc\V1
- A request to create a cluster.
- JobControllerGrpcClient::CancelJob() — Method in class JobControllerGrpcClient
- Starts a job cancellation request. To access the job resource after cancellation, call regions/{region}/jobs.list or regions/{region}/jobs.get.
- Controller2GrpcClient — Class in namespace Google\Cloud\Debugger\V2
- The Controller service provides the API for orchestrating a collection of debugger agents to perform debugging tasks. These agents are each attached to a process of an application which may include one or more replicas.
- CloudRepoSourceContext — Class in namespace Google\Cloud\DevTools\Source\V1
- A CloudRepoSourceContext denotes a particular revision in a cloud repo (a repo hosted by the Google Cloud Platform).
- CloudWorkspaceId — Class in namespace Google\Cloud\DevTools\Source\V1
- A CloudWorkspaceId is a unique identifier for a cloud workspace.
- CloudWorkspaceSourceContext — Class in namespace Google\Cloud\DevTools\Source\V1
- A CloudWorkspaceSourceContext denotes a workspace at a particular snapshot.
- $SourceContext#context — Property in class SourceContext
- Context — Class in namespace Google\Cloud\Dialogflow\V2
- Represents a context.
- ContextsGrpcClient — Class in namespace Google\Cloud\Dialogflow\V2
- A context represents additional information included with user input or with an intent returned by the Dialogflow API. Contexts are helpful for differentiating user input which may be vague or have a different meaning depending on additional details from your application such as user setting and preferences, previous user input, where the user is in your application, geographic location, and so on.
- ContextsGrpcClient::CreateContext() — Method in class ContextsGrpcClient
- Creates a context.
- CreateContextRequest — Class in namespace Google\Cloud\Dialogflow\V2
- The request message for [Contexts.CreateContext][google.cloud.dialogflow.v2.Contexts.CreateContext].
- CreateEntityTypeRequest — Class in namespace Google\Cloud\Dialogflow\V2
- The request message for [EntityTypes.CreateEntityType][google.cloud.dialogflow.v2.EntityTypes.CreateEntityType].
- CreateIntentRequest — Class in namespace Google\Cloud\Dialogflow\V2
- The request message for [Intents.CreateIntent][google.cloud.dialogflow.v2.Intents.CreateIntent].
- CreateSessionEntityTypeRequest — Class in namespace Google\Cloud\Dialogflow\V2
- The request message for [SessionEntityTypes.CreateSessionEntityType][google.cloud.dialogflow.v2.SessionEntityTypes.CreateSessionEntityType].
- EntityTypesGrpcClient::CreateEntityType() — Method in class EntityTypesGrpcClient
- Creates an entity type in the specified agent.
- IntentsGrpcClient::CreateIntent() — Method in class IntentsGrpcClient
- Creates an intent in the specified agent.
- SessionEntityTypesGrpcClient::CreateSessionEntityType() — Method in class SessionEntityTypesGrpcClient
- Creates a session entity type.
- CancelDlpJobRequest — Class in namespace Google\Cloud\Dlp\V2
- The request message for canceling a DLP job.
- CharacterMaskConfig — Class in namespace Google\Cloud\Dlp\V2
- Partially mask a string by replacing a given number of characters with a fixed character. Masking can start from the beginning or end of the string.
- CharsToIgnore — Class in namespace Google\Cloud\Dlp\V2
- Characters to skip when doing deidentification of a value. These will be left alone and skipped.
- $CharsToIgnore#characters — Property in class CharsToIgnore
- CharsToIgnore_CommonCharsToIgnore — Class in namespace Google\Cloud\Dlp\V2
- Protobuf enum
Google\Privacy\Dlp\V2\CharsToIgnore\CommonCharsToIgnore - CloudStorageOptions — Class in namespace Google\Cloud\Dlp\V2
- Options defining a file or a set of files (path ending with *) within a Google Cloud Storage bucket.
- CloudStorageOptions_FileSet — Class in namespace Google\Cloud\Dlp\V2
- Set of files to scan.
- CloudStorageOptions_SampleMethod — Class in namespace Google\Cloud\Dlp\V2
- How to sample bytes if not all bytes are scanned. Meaningful only when used in conjunction with bytes_limit_per_file. If not specified, scanning would start from the top.
- CloudStoragePath — Class in namespace Google\Cloud\Dlp\V2
- Message representing a single file or path in Cloud Storage.
- Color — Class in namespace Google\Cloud\Dlp\V2
- Represents a color in the RGB color space.
- ContentItem — Class in namespace Google\Cloud\Dlp\V2
- Container structure for the content to inspect.
- ContentLocation — Class in namespace Google\Cloud\Dlp\V2
- Findings container location data.
- ContentOption — Class in namespace Google\Cloud\Dlp\V2
- Options describing which parts of the provided content should be scanned.
- CreateDeidentifyTemplateRequest — Class in namespace Google\Cloud\Dlp\V2
- Request message for CreateDeidentifyTemplate.
- CreateDlpJobRequest — Class in namespace Google\Cloud\Dlp\V2
- Request message for CreateDlpJobRequest. Used to initiate long running jobs such as calculating risk metrics or inspecting Google Cloud Storage.
- CreateInspectTemplateRequest — Class in namespace Google\Cloud\Dlp\V2
- Request message for CreateInspectTemplate.
- CreateJobTriggerRequest — Class in namespace Google\Cloud\Dlp\V2
- Request message for CreateJobTrigger.
- CryptoHashConfig — Class in namespace Google\Cloud\Dlp\V2
- Pseudonymization method that generates surrogates via cryptographic hashing.
- CryptoKey — Class in namespace Google\Cloud\Dlp\V2
- This is a data encryption key (DEK) (as opposed to a key encryption key (KEK) stored by KMS).
- CryptoReplaceFfxFpeConfig — Class in namespace Google\Cloud\Dlp\V2
- Replaces an identifier with a surrogate using FPE with the FFX
mode of operation; however when used in the
ReidentifyContentAPI method, it serves the opposite function by reversing the surrogate back into the original identifier. - CryptoReplaceFfxFpeConfig_FfxCommonNativeAlphabet — Class in namespace Google\Cloud\Dlp\V2
- These are commonly used subsets of the alphabet that the FFX mode natively supports. In the algorithm, the alphabet is selected using the "radix". Therefore each corresponds to particular radix.
- CustomInfoType — Class in namespace Google\Cloud\Dlp\V2
- Custom information type provided by the user. Used to find domain-specific sensitive information configurable to the data in question.
- CustomInfoType_DetectionRule — Class in namespace Google\Cloud\Dlp\V2
- Rule for modifying a custom info type to alter behavior under certain
circumstances, depending on the specific details of the rule. Not supported
for the
surrogate_typecustom info type. - CustomInfoType_DetectionRule_HotwordRule — Class in namespace Google\Cloud\Dlp\V2
- Detection rule that adjusts the likelihood of findings within a certain proximity of hotwords.
- CustomInfoType_DetectionRule_LikelihoodAdjustment — Class in namespace Google\Cloud\Dlp\V2
- Message for specifying an adjustment to the likelihood of a finding as part of a detection rule.
- CustomInfoType_DetectionRule_Proximity — Class in namespace Google\Cloud\Dlp\V2
- Message for specifying a window around a finding to apply a detection rule.
- CustomInfoType_Dictionary — Class in namespace Google\Cloud\Dlp\V2
- Custom information type based on a dictionary of words or phrases. This can be used to match sensitive information specific to the data, such as a list of employee IDs or job titles.
- CustomInfoType_Dictionary_WordList — Class in namespace Google\Cloud\Dlp\V2
- Message defining a list of words or phrases to search for in the data.
- CustomInfoType_Regex — Class in namespace Google\Cloud\Dlp\V2
- Message defining a custom regular expression.
- CustomInfoType_SurrogateType — Class in namespace Google\Cloud\Dlp\V2
- Message for detecting output from deidentification transformations
such as
CryptoReplaceFfxFpeConfig. - DlpServiceGrpcClient::CreateInspectTemplate() — Method in class DlpServiceGrpcClient
- Creates an InspectTemplate for re-using frequently used configuration for inspecting content, images, and storage.
- DlpServiceGrpcClient::CreateDeidentifyTemplate() — Method in class DlpServiceGrpcClient
- Creates a DeidentifyTemplate for re-using frequently used configuration for de-identifying content, images, and storage.
- DlpServiceGrpcClient::CreateJobTrigger() — Method in class DlpServiceGrpcClient
- Creates a job trigger to run DLP actions such as scanning storage for sensitive information on a set schedule.
- DlpServiceGrpcClient::CreateDlpJob() — Method in class DlpServiceGrpcClient
- Creates a new job to inspect storage or calculate risk metrics.
- DlpServiceGrpcClient::CancelDlpJob() — Method in class DlpServiceGrpcClient
- Starts asynchronous cancellation on a long-running DlpJob. The server makes a best effort to cancel the DlpJob, but success is not guaranteed.
- $BatchGetDocumentsRequest#consistency_selector — Property in class BatchGetDocumentsRequest
- CommitRequest — Class in namespace Google\Cloud\Firestore\V1beta1
- The request for [Firestore.Commit][google.firestore.v1beta1.Firestore.Commit].
- CommitResponse — Class in namespace Google\Cloud\Firestore\V1beta1
- The response for [Firestore.Commit][google.firestore.v1beta1.Firestore.Commit].
- CreateDocumentRequest — Class in namespace Google\Cloud\Firestore\V1beta1
- The request for [Firestore.CreateDocument][google.firestore.v1beta1.Firestore.CreateDocument].
- Cursor — Class in namespace Google\Cloud\Firestore\V1beta1
- A position in a query result set.
- FirestoreGrpcClient::CreateDocument() — Method in class FirestoreGrpcClient
- Creates a new document.
- FirestoreGrpcClient::Commit() — Method in class FirestoreGrpcClient
- Commits a transaction, while optionally updating documents.
- $GetDocumentRequest#consistency_selector — Property in class GetDocumentRequest
- $ListDocumentsRequest#consistency_selector — Property in class ListDocumentsRequest
- $Precondition#condition_type — Property in class Precondition
- $RunQueryRequest#consistency_selector — Property in class RunQueryRequest
- $TransactionOptions_ReadOnly#consistency_selector — Property in class TransactionOptions_ReadOnly
- CreateDeviceRegistryRequest — Class in namespace Google\Cloud\Iot\V1
- Request for
CreateDeviceRegistry. - CreateDeviceRequest — Class in namespace Google\Cloud\Iot\V1
- Request for
CreateDevice. - $DeviceCredential#credential — Property in class DeviceCredential
- DeviceManagerGrpcClient::CreateDeviceRegistry() — Method in class DeviceManagerGrpcClient
- Creates a device registry that contains devices.
- DeviceManagerGrpcClient::CreateDevice() — Method in class DeviceManagerGrpcClient
- Creates a device in a device registry.
- $RegistryCredential#credential — Property in class RegistryCredential
- ClassificationCategory — Class in namespace Google\Cloud\Language\V1beta2
- Represents a category returned from the text classifier.
- ClassifyTextRequest — Class in namespace Google\Cloud\Language\V1beta2
- The document classification request message.
- ClassifyTextResponse — Class in namespace Google\Cloud\Language\V1beta2
- The document classification response message.
- LanguageServiceGrpcClient::ClassifyText() — Method in class LanguageServiceGrpcClient
- Classifies a document into categories.
- ConfigServiceV2GrpcClient — Class in namespace Google\Cloud\Logging\V2
- Service for configuring sinks used to export log entries outside of Stackdriver Logging.
- ConfigServiceV2GrpcClient::CreateSink() — Method in class ConfigServiceV2GrpcClient
- Creates a sink that exports specified log entries to a destination. The
export of newly-ingested log entries begins immediately, unless the sink's
writer_identityis not permitted to write to the destination. A sink can export log entries only from the resource owning the sink. - ConfigServiceV2GrpcClient::CreateExclusion() — Method in class ConfigServiceV2GrpcClient
- Creates a new exclusion in a specified parent resource.
- CreateExclusionRequest — Class in namespace Google\Cloud\Logging\V2
- The parameters to
CreateExclusion. - CreateLogMetricRequest — Class in namespace Google\Cloud\Logging\V2
- The parameters to CreateLogMetric.
- CreateSinkRequest — Class in namespace Google\Cloud\Logging\V2
- The parameters to
CreateSink. - MetricsServiceV2GrpcClient::CreateLogMetric() — Method in class MetricsServiceV2GrpcClient
- Creates a logs-based metric.
- AlertPolicyServiceGrpcClient::CreateAlertPolicy() — Method in class AlertPolicyServiceGrpcClient
- Creates a new alerting policy.
- $AlertPolicy_Condition#condition — Property in class AlertPolicy_Condition
- ComparisonType — Class in namespace Google\Cloud\Monitoring\V3
- Specifies an ordering relationship on two arguments, here called left and right.
- CreateAlertPolicyRequest — Class in namespace Google\Cloud\Monitoring\V3
- The protocol for the
CreateAlertPolicyrequest. - CreateGroupRequest — Class in namespace Google\Cloud\Monitoring\V3
- The
CreateGrouprequest. - CreateMetricDescriptorRequest — Class in namespace Google\Cloud\Monitoring\V3
- The
CreateMetricDescriptorrequest. - CreateNotificationChannelRequest — Class in namespace Google\Cloud\Monitoring\V3
- The
CreateNotificationChannelrequest. - CreateTimeSeriesError — Class in namespace Google\Cloud\Monitoring\V3
- Describes the result of a failed request to write data to a time series.
- CreateTimeSeriesRequest — Class in namespace Google\Cloud\Monitoring\V3
- The
CreateTimeSeriesrequest. - CreateUptimeCheckConfigRequest — Class in namespace Google\Cloud\Monitoring\V3
- The protocol for the
CreateUptimeCheckConfigrequest. - GroupServiceGrpcClient::CreateGroup() — Method in class GroupServiceGrpcClient
- Creates a new group.
- MetricServiceGrpcClient::CreateMetricDescriptor() — Method in class MetricServiceGrpcClient
- Creates a new metric descriptor.
- MetricServiceGrpcClient::CreateTimeSeries() — Method in class MetricServiceGrpcClient
- Creates or adds data to one or more time series.
- NotificationChannelServiceGrpcClient::CreateNotificationChannel() — Method in class NotificationChannelServiceGrpcClient
- Creates a new notification channel, representing a single notification endpoint such as an email address, SMS number, or pagerduty service.
- $UptimeCheckConfig#check_request_type — Property in class UptimeCheckConfig
- UptimeCheckServiceGrpcClient::CreateUptimeCheckConfig() — Method in class UptimeCheckServiceGrpcClient
- Creates a new uptime check configuration.
- CreateSnapshotRequest — Class in namespace Google\Cloud\PubSub\V1
- Request for the
CreateSnapshotmethod. - PublisherGrpcClient::CreateTopic() — Method in class PublisherGrpcClient
- Creates the given topic with the given name.
- SubscriberGrpcClient::CreateSubscription() — Method in class SubscriberGrpcClient
- Creates a subscription to a given topic.
- SubscriberGrpcClient::CreateSnapshot() — Method in class SubscriberGrpcClient
- Creates a snapshot from the requested subscription.
- CloudRedisGrpcClient — Class in namespace Google\Cloud\Redis\V1beta1
- Configures and manages Cloud Memorystore for Redis instances
- CloudRedisGrpcClient::CreateInstance() — Method in class CloudRedisGrpcClient
- Creates a Redis instance based on the specified tier and memory size.
- CreateInstanceRequest — Class in namespace Google\Cloud\Redis\V1beta1
- Request for [CreateInstance][google.cloud.redis.v1beta1.CloudRedis.CreateInstance].
- CreateDatabaseMetadata — Class in namespace Google\Cloud\Spanner\Admin\Database\V1
- Metadata type for the operation returned by [CreateDatabase][google.spanner.admin.database.v1.DatabaseAdmin.CreateDatabase].
- CreateDatabaseRequest — Class in namespace Google\Cloud\Spanner\Admin\Database\V1
- The request for [CreateDatabase][google.spanner.admin.database.v1.DatabaseAdmin.CreateDatabase].
- DatabaseAdminGrpcClient::CreateDatabase() — Method in class DatabaseAdminGrpcClient
- Creates a new Cloud Spanner database and starts to prepare it for serving.
- CreateInstanceMetadata — Class in namespace Google\Cloud\Spanner\Admin\Instance\V1
- Metadata type for the operation returned by [CreateInstance][google.spanner.admin.instance.v1.InstanceAdmin.CreateInstance].
- CreateInstanceRequest — Class in namespace Google\Cloud\Spanner\Admin\Instance\V1
- The request for [CreateInstance][google.spanner.admin.instance.v1.InstanceAdmin.CreateInstance].
- InstanceAdminGrpcClient::CreateInstance() — Method in class InstanceAdminGrpcClient
- Creates an instance and begins preparing it to begin serving. The
returned [long-running operation][google.longrunning.Operation]
can be used to track the progress of preparing the new
instance. The instance name is assigned by the caller. If the
named instance already exists,
CreateInstancereturnsALREADY_EXISTS. - CommitRequest — Class in namespace Google\Cloud\Spanner\V1
- The request for [Commit][google.spanner.v1.Spanner.Commit].
- CommitResponse — Class in namespace Google\Cloud\Spanner\V1
- The response for [Commit][google.spanner.v1.Spanner.Commit].
- CreateSessionRequest — Class in namespace Google\Cloud\Spanner\V1
- The request for [CreateSession][google.spanner.v1.Spanner.CreateSession].
- SpannerGrpcClient::CreateSession() — Method in class SpannerGrpcClient
- Creates a new session. A session can be used to perform transactions that read and/or modify data in a Cloud Spanner database.
- SpannerGrpcClient::Commit() — Method in class SpannerGrpcClient
- Commits a transaction. The request includes the mutations to be applied to rows in the database.
- CancelLeaseRequest — Class in namespace Google\Cloud\Tasks\V2beta2
- Request message for canceling a lease using [CancelLease][google.cloud.tasks.v2beta2.CloudTasks.CancelLease].
- CloudTasksGrpcClient — Class in namespace Google\Cloud\Tasks\V2beta2
- Cloud Tasks allows developers to manage the execution of background work in their applications.
- CloudTasksGrpcClient::CreateQueue() — Method in class CloudTasksGrpcClient
- Creates a queue.
- CloudTasksGrpcClient::CreateTask() — Method in class CloudTasksGrpcClient
- Creates a task and adds it to a queue.
- CloudTasksGrpcClient::CancelLease() — Method in class CloudTasksGrpcClient
- Cancel a pull task's lease.
- CreateQueueRequest — Class in namespace Google\Cloud\Tasks\V2beta2
- Request message for [CreateQueue][google.cloud.tasks.v2beta2.CloudTasks.CreateQueue].
- CreateTaskRequest — Class in namespace Google\Cloud\Tasks\V2beta2
- Request message for [CreateTask][google.cloud.tasks.v2beta2.CloudTasks.CreateTask].
- TraceServiceGrpcClient::CreateSpan() — Method in class TraceServiceGrpcClient
- Creates a new span.
- ColorInfo — Class in namespace Google\Cloud\Vision\V1
- Color information consists of RGB channels, score, and the fraction of the image that the color occupies in the image.
- CropHint — Class in namespace Google\Cloud\Vision\V1
- Single crop hint that is used to generate a new crop when serving an image.
- CropHintsAnnotation — Class in namespace Google\Cloud\Vision\V1
- Set of crop hints that are used to generate new crops when serving images.
- CropHintsParams — Class in namespace Google\Cloud\Vision\V1
- Parameters for crop hints annotation request.
- CancelOperationRequest — Class in namespace Google\LongRunning
- The request message for [Operations.CancelOperation][google.longrunning.Operations.CancelOperation].
- OperationsGrpcClient::CancelOperation() — Method in class OperationsGrpcClient
- Starts asynchronous cancellation on a long-running operation. The server
makes a best effort to cancel the operation, but success is not
guaranteed. If the server doesn't support this method, it returns
google.rpc.Code.UNIMPLEMENTED. Clients can use [Operations.GetOperation][google.longrunning.Operations.GetOperation] or other methods to check whether the cancellation succeeded or whether the operation completed despite cancellation. On successful cancellation, the operation is not deleted; instead, it becomes an operation with an [Operation.error][google.longrunning.Operation.error] value with a [google.rpc.Status.code][google.rpc.Status.code] of 1, corresponding toCode.CANCELLED. - Code — Class in namespace Google\Rpc
- The canonical error codes for Google APIs.
- Color — Class in namespace Google\Type
- Represents a color in the RGBA color space. This representation is designed for simplicity of conversion to/from color representations in various languages over compactness; for example, the fields of this representation can be trivially provided to the constructor of "java.awt.Color" in Java; it can also be trivially provided to UIColor's "+colorWithRed:green:blue:alpha" method in iOS; and, with just a little work, it can be easily formatted into a CSS "rgba()" string in JavaScript, as well. Here are some examples: Example (Java): import com.google.type.Color; // .
D
- $Parser#defaultActions — Property in class Parser
- $Parser#debug — Property in class Parser
- $Parser#done — Property in class Parser
- Segment::decrementSegmentCount() — Method in class Segment
- OperationsGapicClient::deleteOperation() — Method in class OperationsGapicClient
- Deletes a long-running operation. This method indicates that the client is
no longer interested in the operation result. It does not cancel the
operation. If the server doesn't support this method, it returns
google.rpc.Code.UNIMPLEMENTED. - OperationResponse::delete() — Method in class OperationResponse
- Delete the long-running operation. This method indicates that the client is no longer interested in the operation result. It does not cancel the operation.
- Serializer::decodeMessage() — Method in class Serializer
- Decode PHP array into the specified protobuf message
- Serializer::decodeMetadata() — Method in class Serializer
- Decode metadata received from gRPC status object
- $MockStatus#details — Property in class MockStatus
- SerializationTrait::deserializeMessage() — Method in class SerializationTrait
- Distribution — Class in namespace Google\Api
- Distribution contains summary statistics for a population of values and, optionally, a histogram representing the distribution of those values across a specified set of histogram buckets.
- Distribution_BucketOptions — Class in namespace Google\Api
- A Distribution may optionally contain a histogram of the values in the
population. The histogram is given in
bucket_countsas counts of values that fall into one of a sequence of non-overlapping buckets. The sequence of buckets is described bybucket_options. - Distribution_BucketOptions_Explicit — Class in namespace Google\Api
- A set of buckets with arbitrary widths.
- Distribution_BucketOptions_Exponential — Class in namespace Google\Api
- Specify a sequence of buckets that have a width that is proportional to the value of the lower bound. Each bucket represents a constant relative uncertainty on a specific value in the bucket.
- Distribution_BucketOptions_Linear — Class in namespace Google\Api
- Specify a sequence of buckets that all have the same width (except overflow and underflow). Each bucket represents a constant absolute uncertainty on the specific value in the bucket.
- Distribution_Range — Class in namespace Google\Api
- The range of the population values.
- Documentation — Class in namespace Google\Api
Documentationprovides the information for describing a service.- DocumentationRule — Class in namespace Google\Api
- A documentation rule provides information about individual API elements.
- DataSource — Class in namespace Google\Cloud\BigQuery\DataTransfer\V1
- Represents data source metadata. Metadata is sufficient to render UI and request proper OAuth tokens.
- DataSourceParameter — Class in namespace Google\Cloud\BigQuery\DataTransfer\V1
- Represents a data source parameter with validation rules, so that parameters can be rendered in the UI. These parameters are given to us by supported data sources, and include all needed information for rendering and validation.
- DataSourceParameter_Type — Class in namespace Google\Cloud\BigQuery\DataTransfer\V1
- Parameter type.
- DataSource_AuthorizationType — Class in namespace Google\Cloud\BigQuery\DataTransfer\V1
- The type of authorization needed for this data source.
- DataSource_DataRefreshType — Class in namespace Google\Cloud\BigQuery\DataTransfer\V1
- Represents how the data source supports data auto refresh.
- DataTransferServiceGrpcClient — Class in namespace Google\Cloud\BigQuery\DataTransfer\V1
- The Google BigQuery Data Transfer Service API enables BigQuery users to configure the transfer of their data from other Google Products into BigQuery.
- DataTransferServiceGrpcClient::DeleteTransferConfig() — Method in class DataTransferServiceGrpcClient
- Deletes a data transfer configuration, including any associated transfer runs and logs.
- DataTransferServiceGrpcClient::DeleteTransferRun() — Method in class DataTransferServiceGrpcClient
- Deletes the specified transfer run.
- DeleteTransferConfigRequest — Class in namespace Google\Cloud\BigQuery\DataTransfer\V1
- A request to delete data transfer information. All associated transfer runs and log messages will be deleted as well.
- DeleteTransferRunRequest — Class in namespace Google\Cloud\BigQuery\DataTransfer\V1
- A request to delete data transfer run information.
- BigtableInstanceAdminGrpcClient::DeleteInstance() — Method in class BigtableInstanceAdminGrpcClient
- Delete an instance from a project.
- BigtableInstanceAdminGrpcClient::DeleteCluster() — Method in class BigtableInstanceAdminGrpcClient
- Deletes a cluster from an instance.
- BigtableInstanceAdminGrpcClient::DeleteAppProfile() — Method in class BigtableInstanceAdminGrpcClient
- Deletes an app profile from an instance.
- BigtableTableAdminGrpcClient::DeleteTable() — Method in class BigtableTableAdminGrpcClient
- Permanently deletes a specified table and all of its data.
- BigtableTableAdminGrpcClient::DropRowRange() — Method in class BigtableTableAdminGrpcClient
- Permanently drop/delete a row range from a specified table. The request can specify whether to delete all rows in a table, or only those that match a particular prefix.
- BigtableTableAdminGrpcClient::DeleteSnapshot() — Method in class BigtableTableAdminGrpcClient
- Permanently deletes the specified snapshot.
- DeleteAppProfileRequest — Class in namespace Google\Cloud\Bigtable\Admin\V2
- Request message for BigtableInstanceAdmin.DeleteAppProfile.
- DeleteClusterRequest — Class in namespace Google\Cloud\Bigtable\Admin\V2
- Request message for BigtableInstanceAdmin.DeleteCluster.
- DeleteInstanceRequest — Class in namespace Google\Cloud\Bigtable\Admin\V2
- Request message for BigtableInstanceAdmin.DeleteInstance.
- DeleteSnapshotRequest — Class in namespace Google\Cloud\Bigtable\Admin\V2
- Request message for [google.bigtable.admin.v2.BigtableTableAdmin.DeleteSnapshot][google.bigtable.admin.v2.BigtableTableAdmin.DeleteSnapshot] Note: This is a private alpha release of Cloud Bigtable snapshots. This feature is not currently available to most Cloud Bigtable customers. This feature might be changed in backward-incompatible ways and is not recommended for production use. It is not subject to any SLA or deprecation policy.
- DeleteTableRequest — Class in namespace Google\Cloud\Bigtable\Admin\V2
- Request message for [google.bigtable.admin.v2.BigtableTableAdmin.DeleteTable][google.bigtable.admin.v2.BigtableTableAdmin.DeleteTable]
- DropRowRangeRequest — Class in namespace Google\Cloud\Bigtable\Admin\V2
- Request message for [google.bigtable.admin.v2.BigtableTableAdmin.DropRowRange][google.bigtable.admin.v2.BigtableTableAdmin.DropRowRange]
- ClusterManagerGrpcClient::DeleteCluster() — Method in class ClusterManagerGrpcClient
- Deletes the cluster, including the Kubernetes endpoint and all worker nodes.
- ClusterManagerGrpcClient::DeleteNodePool() — Method in class ClusterManagerGrpcClient
- Deletes a node pool from a cluster.
- DailyMaintenanceWindow — Class in namespace Google\Cloud\Container\V1
- Time window specified for daily maintenance operations.
- DeleteClusterRequest — Class in namespace Google\Cloud\Container\V1
- DeleteClusterRequest deletes a cluster.
- DeleteNodePoolRequest — Class in namespace Google\Cloud\Container\V1
- DeleteNodePoolRequest deletes a node pool for a cluster.
- ClusterControllerGrpcClient::DeleteCluster() — Method in class ClusterControllerGrpcClient
- Deletes a cluster in a project.
- ClusterControllerGrpcClient::DiagnoseCluster() — Method in class ClusterControllerGrpcClient
- Gets cluster diagnostic information.
- DeleteClusterRequest — Class in namespace Google\Cloud\Dataproc\V1
- A request to delete a cluster.
- DeleteJobRequest — Class in namespace Google\Cloud\Dataproc\V1
- A request to delete a job.
- DiagnoseClusterRequest — Class in namespace Google\Cloud\Dataproc\V1
- A request to collect cluster diagnostic information.
- DiagnoseClusterResults — Class in namespace Google\Cloud\Dataproc\V1
- The location of diagnostic output.
- DiskConfig — Class in namespace Google\Cloud\Dataproc\V1
- Specifies the config of disk options for a group of VM instances.
- $HadoopJob#driver — Property in class HadoopJob
- JobControllerGrpcClient::DeleteJob() — Method in class JobControllerGrpcClient
- Deletes the job from the project. If the job is active, the delete fails,
and the response returns
FAILED_PRECONDITION. - $SparkJob#driver — Property in class SparkJob
- Debuggee — Class in namespace Google\Cloud\Debugger\V2
- Represents the debugged application. The application may include one or more replicated processes executing the same code. Each of these processes is attached with a debugger agent, carrying out the debugging commands.
- Debugger2GrpcClient — Class in namespace Google\Cloud\Debugger\V2
- The Debugger service provides the API that allows users to collect run-time information from a running application, without stopping or slowing it down and without modifying its state. An application may include one or more replicated processes performing the same work.
- Debugger2GrpcClient::DeleteBreakpoint() — Method in class Debugger2GrpcClient
- Deletes the breakpoint from the debuggee.
- DeleteBreakpointRequest — Class in namespace Google\Cloud\Debugger\V2
- Request to delete a breakpoint.
- ContextsGrpcClient::DeleteContext() — Method in class ContextsGrpcClient
- Deletes the specified context.
- ContextsGrpcClient::DeleteAllContexts() — Method in class ContextsGrpcClient
- Deletes all active contexts in the specified session.
- DeleteAllContextsRequest — Class in namespace Google\Cloud\Dialogflow\V2
- The request message for [Contexts.DeleteAllContexts][google.cloud.dialogflow.v2.Contexts.DeleteAllContexts].
- DeleteContextRequest — Class in namespace Google\Cloud\Dialogflow\V2
- The request message for [Contexts.DeleteContext][google.cloud.dialogflow.v2.Contexts.DeleteContext].
- DeleteEntityTypeRequest — Class in namespace Google\Cloud\Dialogflow\V2
- The request message for [EntityTypes.DeleteEntityType][google.cloud.dialogflow.v2.EntityTypes.DeleteEntityType].
- DeleteIntentRequest — Class in namespace Google\Cloud\Dialogflow\V2
- The request message for [Intents.DeleteIntent][google.cloud.dialogflow.v2.Intents.DeleteIntent].
- DeleteSessionEntityTypeRequest — Class in namespace Google\Cloud\Dialogflow\V2
- The request message for [SessionEntityTypes.DeleteSessionEntityType][google.cloud.dialogflow.v2.SessionEntityTypes.DeleteSessionEntityType].
- DetectIntentRequest — Class in namespace Google\Cloud\Dialogflow\V2
- The request to detect user's intent.
- DetectIntentResponse — Class in namespace Google\Cloud\Dialogflow\V2
- The message returned from the DetectIntent method.
- EntityTypesGrpcClient::DeleteEntityType() — Method in class EntityTypesGrpcClient
- Deletes the specified entity type.
- IntentsGrpcClient::DeleteIntent() — Method in class IntentsGrpcClient
- Deletes the specified intent.
- SessionEntityTypesGrpcClient::DeleteSessionEntityType() — Method in class SessionEntityTypesGrpcClient
- Deletes the specified session entity type.
- SessionsGrpcClient::DetectIntent() — Method in class SessionsGrpcClient
- Processes a natural language query and returns structured, actionable data as a result. This method is not idempotent, because it may cause contexts and session entity types to be updated, which in turn might affect results of future queries.
- $ContentItem#data_item — Property in class ContentItem
- DatastoreKey — Class in namespace Google\Cloud\Dlp\V2
- Record key for a finding in Cloud Datastore.
- DatastoreOptions — Class in namespace Google\Cloud\Dlp\V2
- Options defining a data set within Google Cloud Datastore.
- DateShiftConfig — Class in namespace Google\Cloud\Dlp\V2
- Shifts dates by random number of days, with option to be consistent for the same context.
- DateTime — Class in namespace Google\Cloud\Dlp\V2
- Message for a date time object.
- DateTime_TimeZone — Class in namespace Google\Cloud\Dlp\V2
- Generated from protobuf message
google.privacy.dlp.v2.DateTime.TimeZone - DeidentifyConfig — Class in namespace Google\Cloud\Dlp\V2
- The configuration that controls how the data will change.
- DeidentifyContentRequest — Class in namespace Google\Cloud\Dlp\V2
- Request to de-identify a list of items.
- DeidentifyContentResponse — Class in namespace Google\Cloud\Dlp\V2
- Results of de-identifying a ContentItem.
- DeidentifyTemplate — Class in namespace Google\Cloud\Dlp\V2
- The DeidentifyTemplates contains instructions on how to deidentify content.
- DeleteDeidentifyTemplateRequest — Class in namespace Google\Cloud\Dlp\V2
- Request message for DeleteDeidentifyTemplate.
- DeleteDlpJobRequest — Class in namespace Google\Cloud\Dlp\V2
- The request message for deleting a DLP job.
- DeleteInspectTemplateRequest — Class in namespace Google\Cloud\Dlp\V2
- Request message for DeleteInspectTemplate.
- DeleteJobTriggerRequest — Class in namespace Google\Cloud\Dlp\V2
- Request message for DeleteJobTrigger.
- DlpJob — Class in namespace Google\Cloud\Dlp\V2
- Combines all of the information about a DLP job.
- $DlpJob#details — Property in class DlpJob
- DlpJobType — Class in namespace Google\Cloud\Dlp\V2
- An enum to represent the various type of DLP jobs.
- DlpJob_JobState — Class in namespace Google\Cloud\Dlp\V2
- Protobuf enum
Google\Privacy\Dlp\V2\DlpJob\JobState - DlpServiceGrpcClient — Class in namespace Google\Cloud\Dlp\V2
- The Cloud Data Loss Prevention (DLP) API is a service that allows clients to detect the presence of Personally Identifiable Information (PII) and other privacy-sensitive data in user-supplied, unstructured data streams, like text blocks or images.
- DlpServiceGrpcClient::DeidentifyContent() — Method in class DlpServiceGrpcClient
- De-identifies potentially sensitive info from a ContentItem.
- DlpServiceGrpcClient::DeleteInspectTemplate() — Method in class DlpServiceGrpcClient
- Deletes an InspectTemplate.
- DlpServiceGrpcClient::DeleteDeidentifyTemplate() — Method in class DlpServiceGrpcClient
- Deletes a DeidentifyTemplate.
- DlpServiceGrpcClient::DeleteJobTrigger() — Method in class DlpServiceGrpcClient
- Deletes a job trigger.
- DlpServiceGrpcClient::DeleteDlpJob() — Method in class DlpServiceGrpcClient
- Deletes a long-running DlpJob. This method indicates that the client is no longer interested in the DlpJob result. The job will be cancelled if possible.
- DocumentLocation — Class in namespace Google\Cloud\Dlp\V2
- Location of a finding within a document.
- DeleteEventsRequest — Class in namespace Google\Cloud\ErrorReporting\V1beta1
- Deletes all events in the project.
- DeleteEventsResponse — Class in namespace Google\Cloud\ErrorReporting\V1beta1
- Response message for deleting error events.
- ErrorStatsServiceGrpcClient::DeleteEvents() — Method in class ErrorStatsServiceGrpcClient
- Deletes all error events of a given project.
- DeleteDocumentRequest — Class in namespace Google\Cloud\Firestore\V1beta1
- The request for [Firestore.DeleteDocument][google.firestore.v1beta1.Firestore.DeleteDocument].
- Document — Class in namespace Google\Cloud\Firestore\V1beta1
- A Firestore document.
- DocumentChange — Class in namespace Google\Cloud\Firestore\V1beta1
- A [Document][google.firestore.v1beta1.Document] has changed.
- DocumentDelete — Class in namespace Google\Cloud\Firestore\V1beta1
- A [Document][google.firestore.v1beta1.Document] has been deleted.
- DocumentMask — Class in namespace Google\Cloud\Firestore\V1beta1
- A set of field paths on a document.
- DocumentRemove — Class in namespace Google\Cloud\Firestore\V1beta1
- A [Document][google.firestore.v1beta1.Document] has been removed from the view of the targets.
- DocumentTransform — Class in namespace Google\Cloud\Firestore\V1beta1
- A transformation of a document.
- DocumentTransform_FieldTransform — Class in namespace Google\Cloud\Firestore\V1beta1
- A transformation of a field of the document.
- DocumentTransform_FieldTransform_ServerValue — Class in namespace Google\Cloud\Firestore\V1beta1
- A value that is calculated by the server.
- FirestoreGrpcClient::DeleteDocument() — Method in class FirestoreGrpcClient
- Deletes a document.
- DeleteDeviceRegistryRequest — Class in namespace Google\Cloud\Iot\V1
- Request for
DeleteDeviceRegistry. - DeleteDeviceRequest — Class in namespace Google\Cloud\Iot\V1
- Request for
DeleteDevice. - Device — Class in namespace Google\Cloud\Iot\V1
- The device resource.
- DeviceConfig — Class in namespace Google\Cloud\Iot\V1
- The device configuration. Eventually delivered to devices.
- DeviceCredential — Class in namespace Google\Cloud\Iot\V1
- A server-stored device credential used for authentication.
- DeviceManagerGrpcClient — Class in namespace Google\Cloud\Iot\V1
- Internet of things (IoT) service. Allows to manipulate device registry instances and the registration of devices (Things) to the cloud.
- DeviceManagerGrpcClient::DeleteDeviceRegistry() — Method in class DeviceManagerGrpcClient
- Deletes a device registry configuration.
- DeviceManagerGrpcClient::DeleteDevice() — Method in class DeviceManagerGrpcClient
- Deletes a device.
- DeviceRegistry — Class in namespace Google\Cloud\Iot\V1
- A container for a group of devices.
- DeviceState — Class in namespace Google\Cloud\Iot\V1
- The device state, as reported by the device.
- DependencyEdge — Class in namespace Google\Cloud\Language\V1beta2
- Represents dependency parse tree information for a token.
- DependencyEdge_Label — Class in namespace Google\Cloud\Language\V1beta2
- The parse label enum for the token.
- Document — Class in namespace Google\Cloud\Language\V1beta2
##########################################################
Represents the input to API methods.
- Document_Type — Class in namespace Google\Cloud\Language\V1beta2
- The document types enum.
- ConfigServiceV2GrpcClient::DeleteSink() — Method in class ConfigServiceV2GrpcClient
- Deletes a sink. If the sink has a unique
writer_identity, then that service account is also deleted. - ConfigServiceV2GrpcClient::DeleteExclusion() — Method in class ConfigServiceV2GrpcClient
- Deletes an exclusion.
- DeleteExclusionRequest — Class in namespace Google\Cloud\Logging\V2
- The parameters to
DeleteExclusion. - DeleteLogMetricRequest — Class in namespace Google\Cloud\Logging\V2
- The parameters to DeleteLogMetric.
- DeleteLogRequest — Class in namespace Google\Cloud\Logging\V2
- The parameters to DeleteLog.
- DeleteSinkRequest — Class in namespace Google\Cloud\Logging\V2
- The parameters to
DeleteSink. - LoggingServiceV2GrpcClient::DeleteLog() — Method in class LoggingServiceV2GrpcClient
- Deletes all the log entries in a log.
- MetricsServiceV2GrpcClient::DeleteLogMetric() — Method in class MetricsServiceV2GrpcClient
- Deletes a logs-based metric.
- AlertPolicyServiceGrpcClient::DeleteAlertPolicy() — Method in class AlertPolicyServiceGrpcClient
- Deletes an alerting policy.
- DeleteAlertPolicyRequest — Class in namespace Google\Cloud\Monitoring\V3
- The protocol for the
DeleteAlertPolicyrequest. - DeleteGroupRequest — Class in namespace Google\Cloud\Monitoring\V3
- The
DeleteGrouprequest. You can only delete a group if it has no children. - DeleteMetricDescriptorRequest — Class in namespace Google\Cloud\Monitoring\V3
- The
DeleteMetricDescriptorrequest. - DeleteNotificationChannelRequest — Class in namespace Google\Cloud\Monitoring\V3
- The
DeleteNotificationChannelrequest. - DeleteUptimeCheckConfigRequest — Class in namespace Google\Cloud\Monitoring\V3
- The protocol for the
DeleteUptimeCheckConfigrequest. - GroupServiceGrpcClient::DeleteGroup() — Method in class GroupServiceGrpcClient
- Deletes an existing group.
- MetricServiceGrpcClient::DeleteMetricDescriptor() — Method in class MetricServiceGrpcClient
- Deletes a metric descriptor. Only user-created custom metrics can be deleted.
- NotificationChannelServiceGrpcClient::DeleteNotificationChannel() — Method in class NotificationChannelServiceGrpcClient
- Deletes a notification channel.
- UptimeCheckServiceGrpcClient::DeleteUptimeCheckConfig() — Method in class UptimeCheckServiceGrpcClient
- Deletes an uptime check configuration. Note that this method will fail if the uptime check configuration is referenced by an alert policy or other dependent configs that would be rendered invalid by the deletion.
- DeletePosixAccountRequest — Class in namespace Google\Cloud\OsLogin\V1beta
- A request message for deleting a POSIX account entry.
- DeleteSshPublicKeyRequest — Class in namespace Google\Cloud\OsLogin\V1beta
- A request message for deleting an SSH public key.
- OsLoginServiceGrpcClient::DeletePosixAccount() — Method in class OsLoginServiceGrpcClient
- Deletes a POSIX account.
- OsLoginServiceGrpcClient::DeleteSshPublicKey() — Method in class OsLoginServiceGrpcClient
- Deletes an SSH public key.
- DeleteSnapshotRequest — Class in namespace Google\Cloud\PubSub\V1
- Request for the
DeleteSnapshotmethod. - DeleteSubscriptionRequest — Class in namespace Google\Cloud\PubSub\V1
- Request for the DeleteSubscription method.
- DeleteTopicRequest — Class in namespace Google\Cloud\PubSub\V1
- Request for the
DeleteTopicmethod. - PublisherGrpcClient::DeleteTopic() — Method in class PublisherGrpcClient
- Deletes the topic with the given name. Returns
NOT_FOUNDif the topic does not exist. After a topic is deleted, a new topic may be created with the same name; this is an entirely new topic with none of the old configuration or subscriptions. Existing subscriptions to this topic are not deleted, but theirtopicfield is set to_deleted-topic_. - SubscriberGrpcClient::DeleteSubscription() — Method in class SubscriberGrpcClient
- Deletes an existing subscription. All messages retained in the subscription
are immediately dropped. Calls to
Pullafter deletion will returnNOT_FOUND. After a subscription is deleted, a new one may be created with the same name, but the new one has no association with the old subscription or its topic unless the same topic is specified. - SubscriberGrpcClient::DeleteSnapshot() — Method in class SubscriberGrpcClient
- Removes an existing snapshot. All messages retained in the snapshot are immediately dropped. After a snapshot is deleted, a new one may be created with the same name, but the new one has no association with the old snapshot or its subscription, unless the same subscription is specified.
- CloudRedisGrpcClient::DeleteInstance() — Method in class CloudRedisGrpcClient
- Deletes a specific Redis instance. Instance stops serving and data is deleted.
- DeleteInstanceRequest — Class in namespace Google\Cloud\Redis\V1beta1
- Request for [DeleteInstance][google.cloud.redis.v1beta1.CloudRedis.DeleteInstance].
- Database — Class in namespace Google\Cloud\Spanner\Admin\Database\V1
- A Cloud Spanner database.
- DatabaseAdminGrpcClient — Class in namespace Google\Cloud\Spanner\Admin\Database\V1
- Cloud Spanner Database Admin API
- DatabaseAdminGrpcClient::DropDatabase() — Method in class DatabaseAdminGrpcClient
- Drops (aka deletes) a Cloud Spanner database.
- Database_State — Class in namespace Google\Cloud\Spanner\Admin\Database\V1
- Indicates the current state of the database.
- DropDatabaseRequest — Class in namespace Google\Cloud\Spanner\Admin\Database\V1
- The request for [DropDatabase][google.spanner.admin.database.v1.DatabaseAdmin.DropDatabase].
- DeleteInstanceRequest — Class in namespace Google\Cloud\Spanner\Admin\Instance\V1
- The request for [DeleteInstance][google.spanner.admin.instance.v1.InstanceAdmin.DeleteInstance].
- InstanceAdminGrpcClient::DeleteInstance() — Method in class InstanceAdminGrpcClient
- Deletes an instance.
- DeleteSessionRequest — Class in namespace Google\Cloud\Spanner\V1
- The request for [DeleteSession][google.spanner.v1.Spanner.DeleteSession].
- SpannerGrpcClient::DeleteSession() — Method in class SpannerGrpcClient
- Ends a session, releasing server resources associated with it.
- CloudTasksGrpcClient::DeleteQueue() — Method in class CloudTasksGrpcClient
- Deletes a queue.
- CloudTasksGrpcClient::DeleteTask() — Method in class CloudTasksGrpcClient
- Deletes a task.
- DeleteQueueRequest — Class in namespace Google\Cloud\Tasks\V2beta2
- Request message for [DeleteQueue][google.cloud.tasks.v2beta2.CloudTasks.DeleteQueue].
- DeleteTaskRequest — Class in namespace Google\Cloud\Tasks\V2beta2
- Request message for deleting a task using [DeleteTask][google.cloud.tasks.v2beta2.CloudTasks.DeleteTask].
- DominantColorsAnnotation — Class in namespace Google\Cloud\Vision\V1
- Set of dominant colors and their corresponding scores.
- DeleteOperationRequest — Class in namespace Google\LongRunning
- The request message for [Operations.DeleteOperation][google.longrunning.Operations.DeleteOperation].
- OperationsGrpcClient::DeleteOperation() — Method in class OperationsGrpcClient
- Deletes a long-running operation. This method indicates that the client is
no longer interested in the operation result. It does not cancel the
operation. If the server doesn't support this method, it returns
google.rpc.Code.UNIMPLEMENTED. - DebugInfo — Class in namespace Google\Rpc
- Describes additional debugging info.
- Date — Class in namespace Google\Type
- Represents a whole calendar date, e.g. date of birth. The time of day and
time zone are either specified elsewhere or are not significant. The date
is relative to the Proleptic Gregorian Calendar. The day may be 0 to
represent a year and month where the day is not significant, e.g. credit card
expiration date. The year may be 0 to represent a month and day independent
of year, e.g. anniversary date. Related types are [google.type.TimeOfDay][google.type.TimeOfDay]
and
google.protobuf.Timestamp. - DayOfWeek — Class in namespace Google\Type
- Represents a day of week.
E
- $Parser#eof — Property in class Parser
- $ParserError#expected — Property in class ParserError
- Page::expandToFixedSizeCollection() — Method in class Page
- Returns a collection of elements with a fixed size set by the collectionSize parameter. The collection will only contain fewer than collectionSize elements if there are no more pages to be retrieved from the server.
- PagedListResponse::expandToFixedSizeCollection() — Method in class PagedListResponse
- Returns a collection of elements with a fixed size set by the collectionSize parameter. The collection will only contain fewer than collectionSize elements if there are no more pages to be retrieved from the server.
- Serializer::encodeMessage() — Method in class Serializer
- Encode protobuf message as a PHP array
- Endpoint — Class in namespace Google\Api
Endpointdescribes a network endpoint that serves a set of APIs.- Experimental — Class in namespace Google\Api
- Experimental service configuration. These configuration options can only be used by whitelisted users.
- $ColumnRange#end_qualifier — Property in class ColumnRange
- $RowRange#end_key — Property in class RowRange
- $ValueRange#end_value — Property in class ValueRange
- ExtendedSourceContext — Class in namespace Google\Cloud\DevTools\Source\V1
- An ExtendedSourceContext is a SourceContext combined with additional details describing the context.
- AgentsGrpcClient::ExportAgent() — Method in class AgentsGrpcClient
- Exports the specified agent to a ZIP file.
- $BatchUpdateEntityTypesRequest#entity_type_batch — Property in class BatchUpdateEntityTypesRequest
- EntityType — Class in namespace Google\Cloud\Dialogflow\V2
- Represents an entity type.
- EntityTypeBatch — Class in namespace Google\Cloud\Dialogflow\V2
- This message is a wrapper around a collection of entity types.
- EntityType_AutoExpansionMode — Class in namespace Google\Cloud\Dialogflow\V2
- Represents different entity type expansion modes. Automated expansion allows an agent to recognize values that have not been explicitly listed in the entity (for example, new kinds of shopping list items).
- EntityType_Entity — Class in namespace Google\Cloud\Dialogflow\V2
- Optional. Represents an entity.
- EntityType_Kind — Class in namespace Google\Cloud\Dialogflow\V2
- Represents kinds of entities.
- EntityTypesGrpcClient — Class in namespace Google\Cloud\Dialogflow\V2
- Entities are extracted from user input and represent parameters that are meaningful to your application. For example, a date range, a proper name such as a geographic location or landmark, and so on. Entities represent actionable data for your application.
- EventInput — Class in namespace Google\Cloud\Dialogflow\V2
- Events allow for matching intents by event name instead of the natural
language input. For instance, input
<event: { name: “welcome_event”, parameters: { name: “Sam” } }>can trigger a personalized welcome response. - ExportAgentRequest — Class in namespace Google\Cloud\Dialogflow\V2
- The request message for [Agents.ExportAgent][google.cloud.dialogflow.v2.Agents.ExportAgent].
- ExportAgentResponse — Class in namespace Google\Cloud\Dialogflow\V2
- The response message for [Agents.ExportAgent][google.cloud.dialogflow.v2.Agents.ExportAgent].
- EntityId — Class in namespace Google\Cloud\Dlp\V2
- An entity in a dataset is a field or set of fields that correspond to a
single person. For example, in medical records the
EntityIdmight be a patient identifier, or for financial records it might be an account identifier. This message is used when generalizations or analysis must take into account that multiple rows correspond to the same entity. - Error — Class in namespace Google\Cloud\Dlp\V2
- Details information about an error encountered during job execution or the results of an unsuccessful activation of the JobTrigger.
- ErrorContext — Class in namespace Google\Cloud\ErrorReporting\V1beta1
- A description of the context in which an error occurred.
- ErrorEvent — Class in namespace Google\Cloud\ErrorReporting\V1beta1
- An error event which is returned by the Error Reporting system.
- ErrorGroup — Class in namespace Google\Cloud\ErrorReporting\V1beta1
- Description of a group of similar error events.
- ErrorGroupOrder — Class in namespace Google\Cloud\ErrorReporting\V1beta1
- A sorting order of error groups.
- ErrorGroupServiceGrpcClient — Class in namespace Google\Cloud\ErrorReporting\V1beta1
- Service for retrieving and updating individual error groups.
- ErrorGroupStats — Class in namespace Google\Cloud\ErrorReporting\V1beta1
- Data extracted for a specific group based on certain filter criteria, such as a given time period and/or service filter.
- ErrorStatsServiceGrpcClient — Class in namespace Google\Cloud\ErrorReporting\V1beta1
- An API for retrieving and managing error statistics as well as data for individual events.
- ExistenceFilter — Class in namespace Google\Cloud\Firestore\V1beta1
- A digest of all the documents that match a given target.
- EventNotificationConfig — Class in namespace Google\Cloud\Iot\V1
- The configuration for forwarding telemetry events.
- EncodingType — Class in namespace Google\Cloud\Language\V1beta2
- Represents the text encoding that the caller uses to process the output.
- Entity — Class in namespace Google\Cloud\Language\V1beta2
- Represents a phrase in the text that is a known entity, such as a person, an organization, or location. The API associates information, such as salience and mentions, with entities.
- EntityMention — Class in namespace Google\Cloud\Language\V1beta2
- Represents a mention for an entity in the text. Currently, proper noun mentions are supported.
- EntityMention_Type — Class in namespace Google\Cloud\Language\V1beta2
- The supported types of mentions.
- Entity_Type — Class in namespace Google\Cloud\Language\V1beta2
- The type of the entity.
- ExecuteSqlRequest — Class in namespace Google\Cloud\Spanner\V1
- The request for [ExecuteSql][google.spanner.v1.Spanner.ExecuteSql] and [ExecuteStreamingSql][google.spanner.v1.Spanner.ExecuteStreamingSql].
- ExecuteSqlRequest_QueryMode — Class in namespace Google\Cloud\Spanner\V1
- Mode in which the query must be processed.
- $KeyRange#end_key_type — Property in class KeyRange
- SpannerGrpcClient::ExecuteSql() — Method in class SpannerGrpcClient
- Executes an SQL query, returning all rows in a single reply. This
method cannot be used to return a result set larger than 10 MiB;
if the query yields more data than that, the query fails with
a
FAILED_PRECONDITIONerror. - SpannerGrpcClient::ExecuteStreamingSql() — Method in class SpannerGrpcClient
- Like [ExecuteSql][google.spanner.v1.Spanner.ExecuteSql], except returns the result set as a stream. Unlike [ExecuteSql][google.spanner.v1.Spanner.ExecuteSql], there is no limit on the size of the returned result set. However, no individual row in the result set can exceed 100 MiB, and no column value can exceed 10 MiB.
- Entity — Class in namespace Google\Cloud\VideoIntelligence\V1
- Detected entity from video analysis.
- ExplicitContentAnnotation — Class in namespace Google\Cloud\VideoIntelligence\V1
- Explicit content annotation (based on per-frame visual signals only).
- ExplicitContentDetectionConfig — Class in namespace Google\Cloud\VideoIntelligence\V1
- Config for EXPLICIT_CONTENT_DETECTION.
- ExplicitContentFrame — Class in namespace Google\Cloud\VideoIntelligence\V1
- Video frame level annotation results for explicit content.
- Entity — Class in namespace Google\Cloud\VideoIntelligence\V1beta2
- Detected entity from video analysis.
- ExplicitContentAnnotation — Class in namespace Google\Cloud\VideoIntelligence\V1beta2
- Explicit content annotation (based on per-frame visual signals only).
- ExplicitContentDetectionConfig — Class in namespace Google\Cloud\VideoIntelligence\V1beta2
- Config for EXPLICIT_CONTENT_DETECTION.
- ExplicitContentFrame — Class in namespace Google\Cloud\VideoIntelligence\V1beta2
- Video frame level annotation results for explicit content.
- EntityAnnotation — Class in namespace Google\Cloud\Vision\V1
- Set of detected entity features.
F
- FixedSizeCollection — Class in namespace Google\ApiCore
- A collection of elements retrieved using one or more API calls. The collection will attempt to retrieve a fixed number of elements, and will make API calls until that fixed number is reached, or there are no more elements to retrieve.
- $Parser#flex — Property in class Parser
- $ParserLocation#firstLine — Property in class ParserLocation
- $ParserLocation#firstColumn — Property in class ParserLocation
- FixedHeaderMiddleware — Class in namespace Google\ApiCore\Middleware
- Middleware to add fixed headers to an API call.
- Family — Class in namespace Google\Cloud\Bigtable\V2
- Specifies (some of) the contents of a single row/column family intersection of a table.
- $RowFilter#filter — Property in class RowFilter
- FormatMessage — Class in namespace Google\Cloud\Debugger\V2
- Represents a message with parameters.
- FieldId — Class in namespace Google\Cloud\Dlp\V2
- General identifier of a data field in a storage service.
- FieldTransformation — Class in namespace Google\Cloud\Dlp\V2
- The transformation to apply to the field.
- FileType — Class in namespace Google\Cloud\Dlp\V2
- Definitions of file type groups to scan.
- Finding — Class in namespace Google\Cloud\Dlp\V2
- Represents a piece of potentially sensitive content.
- FixedSizeBucketingConfig — Class in namespace Google\Cloud\Dlp\V2
- Buckets values based on fixed size ranges. The Bucketing transformation can provide all of this functionality, but requires more configuration. This message is provided as a convenience to the user for simple bucketing strategies.
- FirestoreGrpcClient — Class in namespace Google\Cloud\Firestore\V1beta1
- Specification of the Firestore API.
- $StructuredQuery_Filter#filter_type — Property in class StructuredQuery_Filter
- $ListGroupsRequest#filter — Property in class ListGroupsRequest
- FaceAnnotation — Class in namespace Google\Cloud\VideoIntelligence\V1
- Face annotation.
- FaceDetectionConfig — Class in namespace Google\Cloud\VideoIntelligence\V1
- Config for FACE_DETECTION.
- FaceFrame — Class in namespace Google\Cloud\VideoIntelligence\V1
- Video frame level annotation results for face detection.
- FaceSegment — Class in namespace Google\Cloud\VideoIntelligence\V1
- Video segment level annotation results for face detection.
- Feature — Class in namespace Google\Cloud\VideoIntelligence\V1
- Video annotation feature.
- FaceAnnotation — Class in namespace Google\Cloud\VideoIntelligence\V1beta1
- Face annotation.
- FaceLocation — Class in namespace Google\Cloud\VideoIntelligence\V1beta1
- Face location.
- Feature — Class in namespace Google\Cloud\VideoIntelligence\V1beta1
- Video annotation feature.
- FaceAnnotation — Class in namespace Google\Cloud\VideoIntelligence\V1beta2
- Face annotation.
- FaceDetectionConfig — Class in namespace Google\Cloud\VideoIntelligence\V1beta2
- Config for FACE_DETECTION.
- FaceFrame — Class in namespace Google\Cloud\VideoIntelligence\V1beta2
- Video frame level annotation results for face detection.
- FaceSegment — Class in namespace Google\Cloud\VideoIntelligence\V1beta2
- Video segment level annotation results for face detection.
- Feature — Class in namespace Google\Cloud\VideoIntelligence\V1beta2
- Video annotation feature.
- FaceAnnotation — Class in namespace Google\Cloud\Vision\V1
- A face annotation object contains the results of face detection.
- FaceAnnotation_Landmark — Class in namespace Google\Cloud\Vision\V1
- A face-specific landmark (for example, a face feature).
- FaceAnnotation_Landmark_Type — Class in namespace Google\Cloud\Vision\V1
- Face landmark (feature) type.
- Feature — Class in namespace Google\Cloud\Vision\V1
- The type of Google Cloud Vision API detection to perform, and the maximum
number of results to return for that type. Multiple
Featureobjects can be specified in thefeatureslist. - Feature_Type — Class in namespace Google\Cloud\Vision\V1
- Type of Google Cloud Vision API feature to be extracted.
G
- AgentHeaderDescriptor::getHeader() — Method in class AgentHeaderDescriptor
- Returns an associative array that contains GAPIC header metadata.
- AgentHeaderDescriptor::getApiCoreVersion() — Method in class AgentHeaderDescriptor
- Returns the version string for ApiCore.
- ApiException::getStatus() — Method in class ApiException
- ApiException::getBasicMessage() — Method in class ApiException
- ApiException::getMetadata() — Method in class ApiException
- BidiStream::getBidiStreamingCall() — Method in class BidiStream
- Return the underlying gRPC call object
- Call::getMethod() — Method in class Call
- Call::getCallType() — Method in class Call
- Call::getDecodeType() — Method in class Call
- Call::getMessage() — Method in class Call
- Call::getDescriptor() — Method in class Call
- ClientStream::getClientStreamingCall() — Method in class ClientStream
- Return the underlying gRPC call object
- CredentialsWrapper::getBearerString() — Method in class CredentialsWrapper
- CredentialsWrapper::getAuthorizationHeaderCallback() — Method in class CredentialsWrapper
- FixedSizeCollection::getCollectionSize() — Method in class FixedSizeCollection
- Returns the number of elements in the collection. This will be equal to the collectionSize parameter used at construction unless there are no elements remaining to be retrieved.
- FixedSizeCollection::getNextPageToken() — Method in class FixedSizeCollection
- Returns a page token that can be passed into the API list method to retrieve additional elements.
- FixedSizeCollection::getNextCollection() — Method in class FixedSizeCollection
- Retrieves the next FixedSizeCollection using one or more API calls.
- FixedSizeCollection::getIterator() — Method in class FixedSizeCollection
- Returns an iterator over the elements of the collection.
- GPBLabel — Class in namespace Google\ApiCore
- Container class for Protobuf label constants. See FieldDescriptorProto.Label in https://github.com/google/protobuf/blob/master/src/google/protobuf/descriptor.proto
- GPBType — Class in namespace Google\ApiCore
- Container class for Protobuf type constants. See FieldDescriptorProto.Type in https://github.com/google/protobuf/blob/master/src/google/protobuf/descriptor.proto
- GapicClientTrait — Class in namespace Google\ApiCore
- Common functions used to work with various clients.
- GrpcSupportTrait — Class in namespace Google\ApiCore
- Provides helper methods for gRPC support.
- Segment::getBindingCount() — Method in class Segment
- Segment::getSegmentCount() — Method in class Segment
- OperationsGapicClient::getOperation() — Method in class OperationsGapicClient
- Gets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service.
- RetryMiddleware::getCurrentTimeMs() — Method in class RetryMiddleware
- OperationResponse::getName() — Method in class OperationResponse
- Get the formatted name of the operation
- OperationResponse::getResult() — Method in class OperationResponse
- Return the result of the operation. If operationSucceeded() is false, return null.
- OperationResponse::getError() — Method in class OperationResponse
- If the operation failed, return the status. If operationFailed() is false, return null.
- OperationResponse::getDescriptorOptions() — Method in class OperationResponse
- Get an array containing the values of 'operationReturnType', 'metadataReturnType', and
the polling options
initialPollDelayMillis,pollDelayMultiplier,maxPollDelayMillis, andtotalPollTimeoutMillis. The array can be passed as the $options argument to the constructor when creating another OperationResponse object. - OperationResponse::getLastProtoResponse() — Method in class OperationResponse
- OperationResponse::getOperationsClient() — Method in class OperationResponse
- OperationResponse::getMetadata() — Method in class OperationResponse
- Get the metadata returned with the last proto response. If a metadata type was provided, then the return value will be of that type - otherwise, the return value will be of type Any. If no metadata object is available, returns null.
- Page::getNextPageToken() — Method in class Page
- Returns the next page token from the response.
- Page::getNextPage() — Method in class Page
- Retrieves the next Page object using the next page token.
- Page::getPageElementCount() — Method in class Page
- Return the number of elements in the response.
- Page::getIterator() — Method in class Page
- Return an iterator over the elements in the response.
- Page::getRequestObject() — Method in class Page
- Gets the request object used to generate the Page.
- Page::getResponseObject() — Method in class Page
- Gets the API response object.
- PageStreamingDescriptor::getRequestPageTokenGetMethod() — Method in class PageStreamingDescriptor
- PageStreamingDescriptor::getRequestPageSizeGetMethod() — Method in class PageStreamingDescriptor
- PageStreamingDescriptor::getResponsePageTokenGetMethod() — Method in class PageStreamingDescriptor
- PageStreamingDescriptor::getResourcesGetMethod() — Method in class PageStreamingDescriptor
- PageStreamingDescriptor::getRequestPageTokenSetMethod() — Method in class PageStreamingDescriptor
- PageStreamingDescriptor::getRequestPageSizeSetMethod() — Method in class PageStreamingDescriptor
- PagedListResponse::getPage() — Method in class PagedListResponse
- Return the current page of results.
- Parser::getSegmentCount() — Method in class Parser
- PollingTrait::getCurrentTimeMillis() — Method in class PollingTrait
- Protected to allow overriding for tests
- RequestParamsHeaderDescriptor::getHeader() — Method in class RequestParamsHeaderDescriptor
- Returns an associative array that contains request params header metadata.
- RetrySettings::getNoRetriesRpcTimeoutMillis() — Method in class RetrySettings
- RetrySettings::getRetryableCodes() — Method in class RetrySettings
- RetrySettings::getInitialRetryDelayMillis() — Method in class RetrySettings
- RetrySettings::getRetryDelayMultiplier() — Method in class RetrySettings
- RetrySettings::getMaxRetryDelayMillis() — Method in class RetrySettings
- RetrySettings::getInitialRpcTimeoutMillis() — Method in class RetrySettings
- RetrySettings::getRpcTimeoutMultiplier() — Method in class RetrySettings
- RetrySettings::getMaxRpcTimeoutMillis() — Method in class RetrySettings
- RetrySettings::getTotalTimeoutMillis() — Method in class RetrySettings
- Serializer::getGetter() — Method in class Serializer
- Serializer::getSetter() — Method in class Serializer
- ServerStream::getServerStreamingCall() — Method in class ServerStream
- Return the underlying gRPC call object
- GeneratedTest — Class in namespace Google\ApiCore\Testing
- MockBidiStreamingCall::getStatus() — Method in class MockBidiStreamingCall
- MockGrpcTransport::getRequestArguments() — Method in class MockGrpcTransport
- MockRequest::getPageToken() — Method in class MockRequest
- Generated from protobuf field
string page_token = 1; - MockRequest::getPageSize() — Method in class MockRequest
- Generated from protobuf field
uint64 page_size = 2; - MockRequestBody::getName() — Method in class MockRequestBody
- Generated from protobuf field
string name = 1; - MockRequestBody::getNumber() — Method in class MockRequestBody
- Generated from protobuf field
uint64 number = 2; - MockRequestBody::getRepeatedField() — Method in class MockRequestBody
- Generated from protobuf field
repeated string repeated_field = 3; - MockRequestBody::getNestedMessage() — Method in class MockRequestBody
- Generated from protobuf field
.google.apicore.testing.MockRequestBody nested_message = 4; - MockRequestBody::getFieldMask() — Method in class MockRequestBody
- Generated from protobuf field
.google.protobuf.FieldMask field_mask = 5; - MockRequestBody::getStringValue() — Method in class MockRequestBody
- Generated from protobuf field
.google.protobuf.StringValue string_value = 6; - MockResponse::getName() — Method in class MockResponse
- Generated from protobuf field
string name = 1; - MockResponse::getNumber() — Method in class MockResponse
- Generated from protobuf field
uint64 number = 2; - MockResponse::getResourcesList() — Method in class MockResponse
- Generated from protobuf field
repeated string resources_list = 3; - MockResponse::getNextPageToken() — Method in class MockResponse
- Generated from protobuf field
string next_page_token = 4; - MockServerStreamingCall::getStatus() — Method in class MockServerStreamingCall
- MockStubTrait::getReceivedCallCount() — Method in class MockStubTrait
- ReceivedRequest::getArray() — Method in class ReceivedRequest
- ReceivedRequest::getFuncCall() — Method in class ReceivedRequest
- ReceivedRequest::getRequestObject() — Method in class ReceivedRequest
- ReceivedRequest::getMetadata() — Method in class ReceivedRequest
- ReceivedRequest::getOptions() — Method in class ReceivedRequest
- GrpcTransport — Class in namespace Google\ApiCore\Transport
- A gRPC based transport implementation.
- Advice::getDescription() — Method in class Advice
- Useful description for why this advice was applied and what actions should be taken to mitigate any implied risks.
- AuthProvider::getId() — Method in class AuthProvider
- The unique identifier of the auth provider. It will be referred to by
AuthRequirement.provider_id. - AuthProvider::getIssuer() — Method in class AuthProvider
- Identifies the principal that issued the JWT. See https://tools.ietf.org/html/draft-ietf-oauth-json-web-token-32#section-4.1.1 Usually a URL or an email address.
- AuthProvider::getJwksUri() — Method in class AuthProvider
- URL of the provider's public key set to validate signature of the JWT. See OpenID Discovery.
- AuthProvider::getAudiences() — Method in class AuthProvider
- The list of JWT audiences.
- AuthProvider::getAuthorizationUrl() — Method in class AuthProvider
- Redirect URL if JWT token is required but no present or is expired.
- AuthRequirement::getProviderId() — Method in class AuthRequirement
- [id][google.api.AuthProvider.id] from authentication provider.
- AuthRequirement::getAudiences() — Method in class AuthRequirement
- NOTE: This will be deprecated soon, once AuthProvider.audiences is implemented and accepted in all the runtime components.
- Authentication::getRules() — Method in class Authentication
- A list of authentication rules that apply to individual API methods.
- Authentication::getProviders() — Method in class Authentication
- Defines a set of authentication providers that a service supports.
- AuthenticationRule::getSelector() — Method in class AuthenticationRule
- Selects the methods to which this rule applies.
- AuthenticationRule::getOauth() — Method in class AuthenticationRule
- The requirements for OAuth credentials.
- AuthenticationRule::getAllowWithoutCredential() — Method in class AuthenticationRule
- Whether to allow requests without a credential. The credential can be an OAuth token, Google cookies (first-party auth) or EndUserCreds.
- AuthenticationRule::getRequirements() — Method in class AuthenticationRule
- Requirements for additional authentication providers.
- AuthorizationConfig::getProvider() — Method in class AuthorizationConfig
- The name of the authorization provider, such as firebaserules.googleapis.com.
- Backend::getRules() — Method in class Backend
- A list of API backend rules that apply to individual API methods.
- BackendRule::getSelector() — Method in class BackendRule
- Selects the methods to which this rule applies.
- BackendRule::getAddress() — Method in class BackendRule
- The address of the API backend.
- BackendRule::getDeadline() — Method in class BackendRule
- The number of seconds to wait for a response from a request. The default depends on the deployment context.
- Billing::getConsumerDestinations() — Method in class Billing
- Billing configurations for sending metrics to the consumer project.
- Billing_BillingDestination::getMonitoredResource() — Method in class Billing_BillingDestination
- The monitored resource type. The type must be defined in [Service.monitored_resources][google.api.Service.monitored_resources] section.
- Billing_BillingDestination::getMetrics() — Method in class Billing_BillingDestination
- Names of the metrics to report to this billing destination.
- ConfigChange::getElement() — Method in class ConfigChange
- Object hierarchy path to the change, with levels separated by a '.' character. For repeated fields, an applicable unique identifier field is used for the index (usually selector, name, or id). For maps, the term 'key' is used. If the field has no unique identifier, the numeric index is used.
- ConfigChange::getOldValue() — Method in class ConfigChange
- Value of the changed object in the old Service configuration, in JSON format. This field will not be populated if ChangeType == ADDED.
- ConfigChange::getNewValue() — Method in class ConfigChange
- Value of the changed object in the new Service configuration, in JSON format. This field will not be populated if ChangeType == REMOVED.
- ConfigChange::getChangeType() — Method in class ConfigChange
- The type for this change, either ADDED, REMOVED, or MODIFIED.
- ConfigChange::getAdvices() — Method in class ConfigChange
- Collection of advice provided for this change, useful for determining the possible impact of this change.
- Context::getRules() — Method in class Context
- A list of RPC context rules that apply to individual API methods.
- ContextRule::getSelector() — Method in class ContextRule
- Selects the methods to which this rule applies.
- ContextRule::getRequested() — Method in class ContextRule
- A list of full type names of requested contexts.
- ContextRule::getProvided() — Method in class ContextRule
- A list of full type names of provided contexts.
- Control::getEnvironment() — Method in class Control
- The service control environment to use. If empty, no control plane feature (like quota and billing) will be enabled.
- CustomHttpPattern::getKind() — Method in class CustomHttpPattern
- The name of this custom HTTP verb.
- CustomHttpPattern::getPath() — Method in class CustomHttpPattern
- The path matched by this custom verb.
- Distribution::getCount() — Method in class Distribution
- The number of values in the population. Must be non-negative.
- Distribution::getMean() — Method in class Distribution
- The arithmetic mean of the values in the population. If
countis zero then this field must be zero. - Distribution::getSumOfSquaredDeviation() — Method in class Distribution
- The sum of squared deviations from the mean of the values in the population. For values x_i this is: Sum[i=1.
- Distribution::getRange() — Method in class Distribution
- If specified, contains the range of the population values. The field
must not be present if the
countis zero. - Distribution::getBucketOptions() — Method in class Distribution
- Defines the histogram bucket boundaries.
- Distribution::getBucketCounts() — Method in class Distribution
- If
bucket_optionsis given, then the sum of the values inbucket_countsmust equal the value incount. Ifbucket_optionsis not given, nobucket_countsfields may be given. - Distribution_BucketOptions::getLinearBuckets() — Method in class Distribution_BucketOptions
- The linear bucket.
- Distribution_BucketOptions::getExponentialBuckets() — Method in class Distribution_BucketOptions
- The exponential buckets.
- Distribution_BucketOptions::getExplicitBuckets() — Method in class Distribution_BucketOptions
- The explicit buckets.
- Distribution_BucketOptions::getOptions() — Method in class Distribution_BucketOptions
- Distribution_BucketOptions_Explicit::getBounds() — Method in class Distribution_BucketOptions_Explicit
- The values must be monotonically increasing.
- Distribution_BucketOptions_Exponential::getNumFiniteBuckets() — Method in class Distribution_BucketOptions_Exponential
- Must be greater than 0.
- Distribution_BucketOptions_Exponential::getGrowthFactor() — Method in class Distribution_BucketOptions_Exponential
- Must be greater than 1.
- Distribution_BucketOptions_Exponential::getScale() — Method in class Distribution_BucketOptions_Exponential
- Must be greater than 0.
- Distribution_BucketOptions_Linear::getNumFiniteBuckets() — Method in class Distribution_BucketOptions_Linear
- Must be greater than 0.
- Distribution_BucketOptions_Linear::getWidth() — Method in class Distribution_BucketOptions_Linear
- Must be greater than 0.
- Distribution_BucketOptions_Linear::getOffset() — Method in class Distribution_BucketOptions_Linear
- Lower bound of the first bucket.
- Distribution_Range::getMin() — Method in class Distribution_Range
- The minimum of the population values.
- Distribution_Range::getMax() — Method in class Distribution_Range
- The maximum of the population values.
- Documentation::getSummary() — Method in class Documentation
- A short summary of what the service does. Can only be provided by plain text.
- Documentation::getPages() — Method in class Documentation
- The top level pages for the documentation set.
- Documentation::getRules() — Method in class Documentation
- A list of documentation rules that apply to individual API elements.
- Documentation::getDocumentationRootUrl() — Method in class Documentation
- The URL to the root of documentation.
- Documentation::getOverview() — Method in class Documentation
- Declares a single overview page. For example:
<
pre>
documentation: summary: . - DocumentationRule::getSelector() — Method in class DocumentationRule
- The selector is a comma-separated list of patterns. Each pattern is a qualified name of the element which may end in "*", indicating a wildcard.
- DocumentationRule::getDescription() — Method in class DocumentationRule
- Description of the selected API(s).
- DocumentationRule::getDeprecationDescription() — Method in class DocumentationRule
- Deprecation description of the selected element(s). It can be provided if an
element is marked as
deprecated. - Endpoint::getName() — Method in class Endpoint
- The canonical name of this endpoint.
- Endpoint::getAliases() — Method in class Endpoint
- DEPRECATED: This field is no longer supported. Instead of using aliases, please specify multiple [google.api.Endpoint][google.api.Endpoint] for each of the intented alias.
- Endpoint::getApis() — Method in class Endpoint
- The list of APIs served by this endpoint.
- Endpoint::getFeatures() — Method in class Endpoint
- The list of features enabled on this endpoint.
- Endpoint::getTarget() — Method in class Endpoint
- The specification of an Internet routable address of API frontend that will handle requests to this API Endpoint.
- Endpoint::getAllowCors() — Method in class Endpoint
- Allowing CORS, aka cross-domain traffic, would allow the backends served from this endpoint to receive and respond to HTTP OPTIONS requests. The response will be used by the browser to determine whether the subsequent cross-origin request is allowed to proceed.
- Experimental::getAuthorization() — Method in class Experimental
- Authorization configuration.
- Http::getRules() — Method in class Http
- A list of HTTP configuration rules that apply to individual API methods.
- HttpBody::getContentType() — Method in class HttpBody
- The HTTP Content-Type string representing the content type of the body.
- HttpBody::getData() — Method in class HttpBody
- HTTP body binary data.
- HttpRule::getSelector() — Method in class HttpRule
- Selects methods to which this rule applies.
- HttpRule::getGet() — Method in class HttpRule
- Used for listing and getting information about resources.
- HttpRule::getPut() — Method in class HttpRule
- Used for updating a resource.
- HttpRule::getPost() — Method in class HttpRule
- Used for creating a resource.
- HttpRule::getDelete() — Method in class HttpRule
- Used for deleting a resource.
- HttpRule::getPatch() — Method in class HttpRule
- Used for updating a resource.
- HttpRule::getCustom() — Method in class HttpRule
- Custom pattern is used for defining custom verbs.
- HttpRule::getBody() — Method in class HttpRule
- The name of the request field whose value is mapped to the HTTP body, or
*for mapping all fields not captured by the path pattern to the HTTP body. NOTE: the referred field must not be a repeated field and must be present at the top-level of request message type. - HttpRule::getAdditionalBindings() — Method in class HttpRule
- Additional HTTP bindings for the selector. Nested bindings must
not contain an
additional_bindingsfield themselves (that is, the nesting may only be one level deep). - HttpRule::getPattern() — Method in class HttpRule
- LabelDescriptor::getKey() — Method in class LabelDescriptor
- The label key.
- LabelDescriptor::getValueType() — Method in class LabelDescriptor
- The type of data that can be assigned to the label.
- LabelDescriptor::getDescription() — Method in class LabelDescriptor
- A human-readable description for the label.
- LogDescriptor::getName() — Method in class LogDescriptor
- The name of the log. It must be less than 512 characters long and can include the following characters: upper- and lower-case alphanumeric characters [A-Za-z0-9], and punctuation characters including slash, underscore, hyphen, period [/_-.].
- LogDescriptor::getLabels() — Method in class LogDescriptor
- The set of labels that are available to describe a specific log entry.
- LogDescriptor::getDescription() — Method in class LogDescriptor
- A human-readable description of this log. This information appears in the documentation and can contain details.
- LogDescriptor::getDisplayName() — Method in class LogDescriptor
- The human-readable name for this log. This information appears on the user interface and should be concise.
- Logging::getProducerDestinations() — Method in class Logging
- Logging configurations for sending logs to the producer project.
- Logging::getConsumerDestinations() — Method in class Logging
- Logging configurations for sending logs to the consumer project.
- Logging_LoggingDestination::getMonitoredResource() — Method in class Logging_LoggingDestination
- The monitored resource type. The type must be defined in the [Service.monitored_resources][google.api.Service.monitored_resources] section.
- Logging_LoggingDestination::getLogs() — Method in class Logging_LoggingDestination
- Names of the logs to be sent to this destination. Each name must be defined in the [Service.logs][google.api.Service.logs] section. If the log name is not a domain scoped name, it will be automatically prefixed with the service name followed by "/".
- Metric::getType() — Method in class Metric
- An existing metric type, see [google.api.MetricDescriptor][google.api.MetricDescriptor].
- Metric::getLabels() — Method in class Metric
- The set of label values that uniquely identify this metric. All
labels listed in the
MetricDescriptormust be assigned values. - MetricDescriptor::getName() — Method in class MetricDescriptor
- The resource name of the metric descriptor. Depending on the
implementation, the name typically includes: (1) the parent resource name
that defines the scope of the metric type or of its data; and (2) the
metric's URL-encoded type, which also appears in the
typefield of this descriptor. For example, following is the resource name of a custom metric within the GCP projectmy-project-id: "projects/my-project-id/metricDescriptors/custom.googleapis.com%2Finvoice%2Fpaid%2Famount" - MetricDescriptor::getType() — Method in class MetricDescriptor
- The metric type, including its DNS name prefix. The type is not
URL-encoded. All user-defined custom metric types have the DNS name
custom.googleapis.com. Metric types should use a natural hierarchical grouping. For example: "custom.googleapis.com/invoice/paid/amount" "appengine.googleapis.com/http/server/response_latencies" - MetricDescriptor::getLabels() — Method in class MetricDescriptor
- The set of labels that can be used to describe a specific
instance of this metric type. For example, the
appengine.googleapis.com/http/server/response_latenciesmetric type has a label for the HTTP response code,response_code, so you can look at latencies for successful responses or just for responses that failed. - MetricDescriptor::getMetricKind() — Method in class MetricDescriptor
- Whether the metric records instantaneous values, changes to a value, etc.
- MetricDescriptor::getValueType() — Method in class MetricDescriptor
- Whether the measurement is an integer, a floating-point number, etc.
- MetricDescriptor::getUnit() — Method in class MetricDescriptor
- The unit in which the metric value is reported. It is only applicable
if the
value_typeisINT64,DOUBLE, orDISTRIBUTION. The supported units are a subset of The Unified Code for Units of Measure standard: Basic units (UNIT) *bitbit *Bybyte *ssecond *minminute *hhour *dday Prefixes (PREFIX) *kkilo (103) *Mmega (106) *Ggiga (109) *Ttera (1012) *Ppeta (1015) *Eexa (1018) *Zzetta (1021) *Yyotta (1024) *mmilli (10-3) *umicro (10-6) *nnano (10-9) *ppico (10-12) *ffemto (10-15) *aatto (10-18) *zzepto (10-21) *yyocto (10-24) *Kikibi (210) *Mimebi (220) *Gigibi (230) *Titebi (240) Grammar The grammar includes the dimensionless unit1, such as1/s. - MetricDescriptor::getDescription() — Method in class MetricDescriptor
- A detailed description of the metric, which can be used in documentation.
- MetricDescriptor::getDisplayName() — Method in class MetricDescriptor
- A concise name for the metric, which can be displayed in user interfaces.
- MetricRule::getSelector() — Method in class MetricRule
- Selects the methods to which this rule applies.
- MetricRule::getMetricCosts() — Method in class MetricRule
- Metrics to update when the selected methods are called, and the associated cost applied to each metric.
- MonitoredResource::getType() — Method in class MonitoredResource
- Required. The monitored resource type. This field must match
the
typefield of a [MonitoredResourceDescriptor][google.api.MonitoredResourceDescriptor] object. For example, the type of a Cloud SQL database is"cloudsql_database". - MonitoredResource::getLabels() — Method in class MonitoredResource
- Required. Values for all of the labels listed in the associated monitored
resource descriptor. For example, Cloud SQL databases use the labels
"database_id"and"zone". - MonitoredResourceDescriptor::getName() — Method in class MonitoredResourceDescriptor
- Optional. The resource name of the monitored resource descriptor:
"projects/{project_id}/monitoredResourceDescriptors/{type}"where {type} is the value of thetypefield in this object and {project_id} is a project ID that provides API-specific context for accessing the type. APIs that do not use project information can use the resource name format"monitoredResourceDescriptors/{type}". - MonitoredResourceDescriptor::getType() — Method in class MonitoredResourceDescriptor
- Required. The monitored resource type. For example, the type
"cloudsql_database"represents databases in Google Cloud SQL. - MonitoredResourceDescriptor::getDisplayName() — Method in class MonitoredResourceDescriptor
- Optional. A concise name for the monitored resource type that might be
displayed in user interfaces. It should be a Title Cased Noun Phrase,
without any article or other determiners. For example,
"Google Cloud SQL Database". - MonitoredResourceDescriptor::getDescription() — Method in class MonitoredResourceDescriptor
- Optional. A detailed description of the monitored resource type that might be used in documentation.
- MonitoredResourceDescriptor::getLabels() — Method in class MonitoredResourceDescriptor
- Required. A set of labels used to describe instances of this monitored
resource type. For example, an individual Google Cloud SQL database is
identified by values for the labels
"database_id"and"zone". - Monitoring::getProducerDestinations() — Method in class Monitoring
- Monitoring configurations for sending metrics to the producer project.
- Monitoring::getConsumerDestinations() — Method in class Monitoring
- Monitoring configurations for sending metrics to the consumer project.
- Monitoring_MonitoringDestination::getMonitoredResource() — Method in class Monitoring_MonitoringDestination
- The monitored resource type. The type must be defined in [Service.monitored_resources][google.api.Service.monitored_resources] section.
- Monitoring_MonitoringDestination::getMetrics() — Method in class Monitoring_MonitoringDestination
- Names of the metrics to report to this monitoring destination.
- OAuthRequirements::getCanonicalScopes() — Method in class OAuthRequirements
- The list of publicly documented OAuth scopes that are allowed access. An OAuth token containing any of these scopes will be accepted.
- Page::getName() — Method in class Page
- The name of the page. It will be used as an identity of the page to
generate URI of the page, text of the link to this page in navigation,
etc. The full page name (start from the root page name to this page
concatenated with
.) can be used as reference to the page in your documentation. For example:pages: - name: Tutorial content: (== include tutorial.md ==) subpages: - name: Java content: (== include tutorial_java.md ==)You can reference
Javapage using Markdown reference link syntax:[Java][Tutorial.Java]. - Page::getContent() — Method in class Page
- The Markdown content of the page. You can use
(== include {path} ==)to include content from a Markdown file. - Page::getSubpages() — Method in class Page
- Subpages of this page. The order of subpages specified here will be honored in the generated docset.
- ProjectProperties::getProperties() — Method in class ProjectProperties
- List of per consumer project-specific properties.
- Property::getName() — Method in class Property
- The name of the property (a.k.a key).
- Property::getType() — Method in class Property
- The type of this property.
- Property::getDescription() — Method in class Property
- The description of the property
- Quota::getLimits() — Method in class Quota
- List of
QuotaLimitdefinitions for the service. - Quota::getMetricRules() — Method in class Quota
- List of
MetricRuledefinitions, each one mapping a selected method to one or more metrics. - QuotaLimit::getName() — Method in class QuotaLimit
- Name of the quota limit. The name is used to refer to the limit when overriding the default limit on per-consumer basis.
- QuotaLimit::getDescription() — Method in class QuotaLimit
- Optional. User-visible, extended description for this quota limit.
- QuotaLimit::getDefaultLimit() — Method in class QuotaLimit
- Default number of tokens that can be consumed during the specified duration. This is the number of tokens assigned when a client application developer activates the service for his/her project.
- QuotaLimit::getMaxLimit() — Method in class QuotaLimit
- Maximum number of tokens that can be consumed during the specified duration. Client application developers can override the default limit up to this maximum. If specified, this value cannot be set to a value less than the default limit. If not specified, it is set to the default limit.
- QuotaLimit::getFreeTier() — Method in class QuotaLimit
- Free tier value displayed in the Developers Console for this limit.
- QuotaLimit::getDuration() — Method in class QuotaLimit
- Duration of this limit in textual notation. Example: "100s", "24h", "1d".
- QuotaLimit::getMetric() — Method in class QuotaLimit
- The name of the metric this quota limit applies to. The quota limits with the same metric will be checked together during runtime. The metric must be defined within the service config.
- QuotaLimit::getUnit() — Method in class QuotaLimit
- Specify the unit of the quota limit. It uses the same syntax as [Metric.unit][]. The supported unit kinds are determined by the quota backend system.
- QuotaLimit::getValues() — Method in class QuotaLimit
- Tiered limit values. Also allows for regional or zone overrides for these values if "/{region}" or "/{zone}" is specified in the unit field.
- QuotaLimit::getDisplayName() — Method in class QuotaLimit
- User-visible display name for this limit.
- Service::getConfigVersion() — Method in class Service
- The semantic version of the service configuration. The config version affects the interpretation of the service configuration. For example, certain features are enabled by default for certain config versions.
- Service::getName() — Method in class Service
- The DNS address at which this service is available,
e.g.
calendar.googleapis.com. - Service::getId() — Method in class Service
- A unique ID for a specific instance of this message, typically assigned by the client for tracking purpose. If empty, the server may choose to generate one instead.
- Service::getTitle() — Method in class Service
- The product title for this service.
- Service::getProducerProjectId() — Method in class Service
- The Google project that owns this service.
- Service::getApis() — Method in class Service
- A list of API interfaces exported by this service. Only the
namefield of the [google.protobuf.Api][google.protobuf.Api] needs to be provided by the configuration author, as the remaining fields will be derived from the IDL during the normalization process. It is an error to specify an API interface here which cannot be resolved against the associated IDL files. - Service::getTypes() — Method in class Service
- A list of all proto message types included in this API service.
- Service::getEnums() — Method in class Service
- A list of all enum types included in this API service. Enums
referenced directly or indirectly by the
apisare automatically included. Enums which are not referenced but shall be included should be listed here by name. Example: enums: - name: google.someapi.v1.SomeEnum - Service::getDocumentation() — Method in class Service
- Additional API documentation.
- Service::getBackend() — Method in class Service
- API backend configuration.
- Service::getHttp() — Method in class Service
- HTTP configuration.
- Service::getQuota() — Method in class Service
- Quota configuration.
- Service::getAuthentication() — Method in class Service
- Auth configuration.
- Service::getContext() — Method in class Service
- Context configuration.
- Service::getUsage() — Method in class Service
- Configuration controlling usage of this service.
- Service::getEndpoints() — Method in class Service
- Configuration for network endpoints. If this is empty, then an endpoint with the same name as the service is automatically generated to service all defined APIs.
- Service::getControl() — Method in class Service
- Configuration for the service control plane.
- Service::getLogs() — Method in class Service
- Defines the logs used by this service.
- Service::getMetrics() — Method in class Service
- Defines the metrics used by this service.
- Service::getMonitoredResources() — Method in class Service
- Defines the monitored resources used by this service. This is required by the [Service.monitoring][google.api.Service.monitoring] and [Service.logging][google.api.Service.logging] configurations.
- Service::getBilling() — Method in class Service
- Billing configuration.
- Service::getLogging() — Method in class Service
- Logging configuration.
- Service::getMonitoring() — Method in class Service
- Monitoring configuration.
- Service::getSystemParameters() — Method in class Service
- System parameter configuration.
- Service::getSourceInfo() — Method in class Service
- Output only. The source information for this configuration if available.
- Service::getExperimental() — Method in class Service
- Experimental configuration.
- SourceInfo::getSourceFiles() — Method in class SourceInfo
- All files used during config generation.
- SystemParameter::getName() — Method in class SystemParameter
- Define the name of the parameter, such as "api_key" . It is case sensitive.
- SystemParameter::getHttpHeader() — Method in class SystemParameter
- Define the HTTP header name to use for the parameter. It is case insensitive.
- SystemParameter::getUrlQueryParameter() — Method in class SystemParameter
- Define the URL query parameter name to use for the parameter. It is case sensitive.
- SystemParameterRule::getSelector() — Method in class SystemParameterRule
- Selects the methods to which this rule applies. Use '*' to indicate all methods in all APIs.
- SystemParameterRule::getParameters() — Method in class SystemParameterRule
- Define parameters. Multiple names may be defined for a parameter.
- SystemParameters::getRules() — Method in class SystemParameters
- Define system parameters.
- Usage::getRequirements() — Method in class Usage
- Requirements that must be satisfied before a consumer project can use the
service. Each requirement is of the form <service.name>/
; for example 'serviceusage.googleapis.com/billing-enabled'. - Usage::getRules() — Method in class Usage
- A list of usage rules that apply to individual API methods.
- Usage::getProducerNotificationChannel() — Method in class Usage
- The full resource name of a channel used for sending notifications to the service producer.
- UsageRule::getSelector() — Method in class UsageRule
- Selects the methods to which this rule applies. Use '*' to indicate all methods in all APIs.
- UsageRule::getAllowUnregisteredCalls() — Method in class UsageRule
- True, if the method allows unregistered calls; false otherwise.
- UsageRule::getSkipServiceControl() — Method in class UsageRule
- True, if the method should skip service control. If so, no control plane feature (like quota and billing) will be enabled.
- AuditLog::getServiceName() — Method in class AuditLog
- The name of the API service performing the operation. For example,
"datastore.googleapis.com". - AuditLog::getMethodName() — Method in class AuditLog
- The name of the service method or operation.
- AuditLog::getResourceName() — Method in class AuditLog
- The resource or collection that is the target of the operation.
- AuditLog::getNumResponseItems() — Method in class AuditLog
- The number of items returned from a List or Query API method, if applicable.
- AuditLog::getStatus() — Method in class AuditLog
- The status of the overall operation.
- AuditLog::getAuthenticationInfo() — Method in class AuditLog
- Authentication information.
- AuditLog::getAuthorizationInfo() — Method in class AuditLog
- Authorization information. If there are multiple resources or permissions involved, then there is one AuthorizationInfo element for each {resource, permission} tuple.
- AuditLog::getRequestMetadata() — Method in class AuditLog
- Metadata about the operation.
- AuditLog::getRequest() — Method in class AuditLog
- The operation request. This may not include all request parameters, such as those that are too large, privacy-sensitive, or duplicated elsewhere in the log record.
- AuditLog::getResponse() — Method in class AuditLog
- The operation response. This may not include all response elements, such as those that are too large, privacy-sensitive, or duplicated elsewhere in the log record.
- AuditLog::getServiceData() — Method in class AuditLog
- Other service-specific data about the request, response, and other activities.
- AuthenticationInfo::getPrincipalEmail() — Method in class AuthenticationInfo
- The email address of the authenticated user making the request.
- AuthorizationInfo::getResource() — Method in class AuthorizationInfo
- The resource being accessed, as a REST-style string. For example: bigquery.googlapis.com/projects/PROJECTID/datasets/DATASETID
- AuthorizationInfo::getPermission() — Method in class AuthorizationInfo
- The required IAM permission.
- AuthorizationInfo::getGranted() — Method in class AuthorizationInfo
- Whether or not authorization for
resourceandpermissionwas granted. - RequestMetadata::getCallerIp() — Method in class RequestMetadata
- The IP address of the caller.
- RequestMetadata::getCallerSuppliedUserAgent() — Method in class RequestMetadata
- The user agent of the caller.
- CheckValidCredsRequest::getName() — Method in class CheckValidCredsRequest
- The data source in the form:
projects/{project_id}/dataSources/{data_source_id} - CheckValidCredsResponse::getHasValidCreds() — Method in class CheckValidCredsResponse
- If set to
true, the credentials exist and are valid. - CreateTransferConfigRequest::getParent() — Method in class CreateTransferConfigRequest
- The BigQuery project id where the transfer configuration should be created.
- CreateTransferConfigRequest::getTransferConfig() — Method in class CreateTransferConfigRequest
- Data transfer configuration to create.
- CreateTransferConfigRequest::getAuthorizationCode() — Method in class CreateTransferConfigRequest
- Optional OAuth2 authorization code to use with this transfer configuration.
- DataSource::getName() — Method in class DataSource
- Output only. Data source resource name.
- DataSource::getDataSourceId() — Method in class DataSource
- Data source id.
- DataSource::getDisplayName() — Method in class DataSource
- User friendly data source name.
- DataSource::getDescription() — Method in class DataSource
- User friendly data source description string.
- DataSource::getClientId() — Method in class DataSource
- Data source client id which should be used to receive refresh token.
- DataSource::getScopes() — Method in class DataSource
- Api auth scopes for which refresh token needs to be obtained. Only valid
when
client_idis specified. Ignored otherwise. These are scopes needed by a data source to prepare data and ingest them into BigQuery, e.g., https://www.googleapis.com/auth/bigquery - DataSource::getTransferType() — Method in class DataSource
- Deprecated. This field has no effect.
- DataSource::getSupportsMultipleTransfers() — Method in class DataSource
- Indicates whether the data source supports multiple transfers to different BigQuery targets.
- DataSource::getUpdateDeadlineSeconds() — Method in class DataSource
- The number of seconds to wait for an update from the data source before BigQuery marks the transfer as failed.
- DataSource::getDefaultSchedule() — Method in class DataSource
- Default data transfer schedule.
- DataSource::getSupportsCustomSchedule() — Method in class DataSource
- Specifies whether the data source supports a user defined schedule, or operates on the default schedule.
- DataSource::getParameters() — Method in class DataSource
- Data source parameters.
- DataSource::getHelpUrl() — Method in class DataSource
- Url for the help document for this data source.
- DataSource::getAuthorizationType() — Method in class DataSource
- Indicates the type of authorization.
- DataSource::getDataRefreshType() — Method in class DataSource
- Specifies whether the data source supports automatic data refresh for the past few days, and how it's supported.
- DataSource::getDefaultDataRefreshWindowDays() — Method in class DataSource
- Default data refresh window on days.
- DataSource::getManualRunsDisabled() — Method in class DataSource
- Disables backfilling and manual run scheduling for the data source.
- DataSource::getMinimumScheduleInterval() — Method in class DataSource
- The minimum interval for scheduler to schedule runs.
- DataSourceParameter::getParamId() — Method in class DataSourceParameter
- Parameter identifier.
- DataSourceParameter::getDisplayName() — Method in class DataSourceParameter
- Parameter display name in the user interface.
- DataSourceParameter::getDescription() — Method in class DataSourceParameter
- Parameter description.
- DataSourceParameter::getType() — Method in class DataSourceParameter
- Parameter type.
- DataSourceParameter::getRequired() — Method in class DataSourceParameter
- Is parameter required.
- DataSourceParameter::getRepeated() — Method in class DataSourceParameter
- Can parameter have multiple values.
- DataSourceParameter::getValidationRegex() — Method in class DataSourceParameter
- Regular expression which can be used for parameter validation.
- DataSourceParameter::getAllowedValues() — Method in class DataSourceParameter
- All possible values for the parameter.
- DataSourceParameter::getMinValue() — Method in class DataSourceParameter
- For integer and double values specifies minimum allowed value.
- DataSourceParameter::getMaxValue() — Method in class DataSourceParameter
- For integer and double values specifies maxminum allowed value.
- DataSourceParameter::getFields() — Method in class DataSourceParameter
- When parameter is a record, describes child fields.
- DataSourceParameter::getValidationDescription() — Method in class DataSourceParameter
- Description of the requirements for this field, in case the user input does not fulfill the regex pattern or min/max values.
- DataSourceParameter::getValidationHelpUrl() — Method in class DataSourceParameter
- URL to a help document to further explain the naming requirements.
- DataSourceParameter::getImmutable() — Method in class DataSourceParameter
- Cannot be changed after initial creation.
- DataSourceParameter::getRecurse() — Method in class DataSourceParameter
- If set to true, schema should be taken from the parent with the same parameter_id. Only applicable when parameter type is RECORD.
- DataTransferServiceGrpcClient::GetDataSource() — Method in class DataTransferServiceGrpcClient
- Retrieves a supported data source and returns its settings, which can be used for UI rendering.
- DataTransferServiceGrpcClient::GetTransferConfig() — Method in class DataTransferServiceGrpcClient
- Returns information about a data transfer config.
- DataTransferServiceGrpcClient::GetTransferRun() — Method in class DataTransferServiceGrpcClient
- Returns information about the particular transfer run.
- DeleteTransferConfigRequest::getName() — Method in class DeleteTransferConfigRequest
- The field will contain name of the resource requested, for example:
projects/{project_id}/transferConfigs/{config_id} - DeleteTransferRunRequest::getName() — Method in class DeleteTransferRunRequest
- The field will contain name of the resource requested, for example:
projects/{project_id}/transferConfigs/{config_id}/runs/{run_id} - GetDataSourceRequest — Class in namespace Google\Cloud\BigQuery\DataTransfer\V1
- A request to get data source info.
- GetDataSourceRequest::getName() — Method in class GetDataSourceRequest
- The field will contain name of the resource requested, for example:
projects/{project_id}/dataSources/{data_source_id} - GetTransferConfigRequest — Class in namespace Google\Cloud\BigQuery\DataTransfer\V1
- A request to get data transfer information.
- GetTransferConfigRequest::getName() — Method in class GetTransferConfigRequest
- The field will contain name of the resource requested, for example:
projects/{project_id}/transferConfigs/{config_id} - GetTransferRunRequest — Class in namespace Google\Cloud\BigQuery\DataTransfer\V1
- A request to get data transfer run information.
- GetTransferRunRequest::getName() — Method in class GetTransferRunRequest
- The field will contain name of the resource requested, for example:
projects/{project_id}/transferConfigs/{config_id}/runs/{run_id} - ListDataSourcesRequest::getParent() — Method in class ListDataSourcesRequest
- The BigQuery project id for which data sources should be returned.
- ListDataSourcesRequest::getPageToken() — Method in class ListDataSourcesRequest
- Pagination token, which can be used to request a specific page
of
ListDataSourcesRequestlist results. For multiple-page results,ListDataSourcesResponseoutputs anext_pagetoken, which can be used as thepage_tokenvalue to request the next page of list results. - ListDataSourcesRequest::getPageSize() — Method in class ListDataSourcesRequest
- Page size. The default page size is the maximum value of 1000 results.
- ListDataSourcesResponse::getDataSources() — Method in class ListDataSourcesResponse
- List of supported data sources and their transfer settings.
- ListDataSourcesResponse::getNextPageToken() — Method in class ListDataSourcesResponse
- Output only. The next-pagination token. For multiple-page list results,
this token can be used as the
ListDataSourcesRequest.page_tokento request the next page of list results. - ListTransferConfigsRequest::getParent() — Method in class ListTransferConfigsRequest
- The BigQuery project id for which data sources
should be returned:
projects/{project_id}. - ListTransferConfigsRequest::getDataSourceIds() — Method in class ListTransferConfigsRequest
- When specified, only configurations of requested data sources are returned.
- ListTransferConfigsRequest::getPageToken() — Method in class ListTransferConfigsRequest
- Pagination token, which can be used to request a specific page
of
ListTransfersRequestlist results. For multiple-page results,ListTransfersResponseoutputs anext_pagetoken, which can be used as thepage_tokenvalue to request the next page of list results. - ListTransferConfigsRequest::getPageSize() — Method in class ListTransferConfigsRequest
- Page size. The default page size is the maximum value of 1000 results.
- ListTransferConfigsResponse::getTransferConfigs() — Method in class ListTransferConfigsResponse
- Output only. The stored pipeline transfer configurations.
- ListTransferConfigsResponse::getNextPageToken() — Method in class ListTransferConfigsResponse
- Output only. The next-pagination token. For multiple-page list results,
this token can be used as the
ListTransferConfigsRequest.page_tokento request the next page of list results. - ListTransferLogsRequest::getParent() — Method in class ListTransferLogsRequest
- Transfer run name in the form:
projects/{project_id}/transferConfigs/{config_Id}/runs/{run_id}. - ListTransferLogsRequest::getPageToken() — Method in class ListTransferLogsRequest
- Pagination token, which can be used to request a specific page
of
ListTransferLogsRequestlist results. For multiple-page results,ListTransferLogsResponseoutputs anext_pagetoken, which can be used as thepage_tokenvalue to request the next page of list results. - ListTransferLogsRequest::getPageSize() — Method in class ListTransferLogsRequest
- Page size. The default page size is the maximum value of 1000 results.
- ListTransferLogsRequest::getMessageTypes() — Method in class ListTransferLogsRequest
- Message types to return. If not populated - INFO, WARNING and ERROR messages are returned.
- ListTransferLogsResponse::getTransferMessages() — Method in class ListTransferLogsResponse
- Output only. The stored pipeline transfer messages.
- ListTransferLogsResponse::getNextPageToken() — Method in class ListTransferLogsResponse
- Output only. The next-pagination token. For multiple-page list results,
this token can be used as the
GetTransferRunLogRequest.page_tokento request the next page of list results. - ListTransferRunsRequest::getParent() — Method in class ListTransferRunsRequest
- Name of transfer configuration for which transfer runs should be retrieved.
- ListTransferRunsRequest::getStates() — Method in class ListTransferRunsRequest
- When specified, only transfer runs with requested states are returned.
- ListTransferRunsRequest::getPageToken() — Method in class ListTransferRunsRequest
- Pagination token, which can be used to request a specific page
of
ListTransferRunsRequestlist results. For multiple-page results,ListTransferRunsResponseoutputs anext_pagetoken, which can be used as thepage_tokenvalue to request the next page of list results. - ListTransferRunsRequest::getPageSize() — Method in class ListTransferRunsRequest
- Page size. The default page size is the maximum value of 1000 results.
- ListTransferRunsRequest::getRunAttempt() — Method in class ListTransferRunsRequest
- Indicates how run attempts are to be pulled.
- ListTransferRunsResponse::getTransferRuns() — Method in class ListTransferRunsResponse
- Output only. The stored pipeline transfer runs.
- ListTransferRunsResponse::getNextPageToken() — Method in class ListTransferRunsResponse
- Output only. The next-pagination token. For multiple-page list results,
this token can be used as the
ListTransferRunsRequest.page_tokento request the next page of list results. - ScheduleTransferRunsRequest::getParent() — Method in class ScheduleTransferRunsRequest
- Transfer configuration name in the form:
projects/{project_id}/transferConfigs/{config_id}. - ScheduleTransferRunsRequest::getStartTime() — Method in class ScheduleTransferRunsRequest
- Start time of the range of transfer runs. For example,
"2017-05-25T00:00:00+00:00". - ScheduleTransferRunsRequest::getEndTime() — Method in class ScheduleTransferRunsRequest
- End time of the range of transfer runs. For example,
"2017-05-30T00:00:00+00:00". - ScheduleTransferRunsResponse::getRuns() — Method in class ScheduleTransferRunsResponse
- The transfer runs that were scheduled.
- TransferConfig::getName() — Method in class TransferConfig
- The resource name of the transfer config.
- TransferConfig::getDestinationDatasetId() — Method in class TransferConfig
- The BigQuery target dataset id.
- TransferConfig::getDisplayName() — Method in class TransferConfig
- User specified display name for the data transfer.
- TransferConfig::getDataSourceId() — Method in class TransferConfig
- Data source id. Cannot be changed once data transfer is created.
- TransferConfig::getParams() — Method in class TransferConfig
- Data transfer specific parameters.
- TransferConfig::getSchedule() — Method in class TransferConfig
- Data transfer schedule.
- TransferConfig::getDataRefreshWindowDays() — Method in class TransferConfig
- The number of days to look back to automatically refresh the data.
- TransferConfig::getDisabled() — Method in class TransferConfig
- Is this config disabled. When set to true, no runs are scheduled for a given transfer.
- TransferConfig::getUpdateTime() — Method in class TransferConfig
- Output only. Data transfer modification time. Ignored by server on input.
- TransferConfig::getNextRunTime() — Method in class TransferConfig
- Output only. Next time when data transfer will run.
- TransferConfig::getState() — Method in class TransferConfig
- Output only. State of the most recently updated transfer run.
- TransferConfig::getUserId() — Method in class TransferConfig
- Output only. Unique ID of the user on whose behalf transfer is done.
- TransferConfig::getDatasetRegion() — Method in class TransferConfig
- Output only. Region in which BigQuery dataset is located.
- TransferMessage::getMessageTime() — Method in class TransferMessage
- Time when message was logged.
- TransferMessage::getSeverity() — Method in class TransferMessage
- Message severity.
- TransferMessage::getMessageText() — Method in class TransferMessage
- Message text.
- TransferRun::getName() — Method in class TransferRun
- The resource name of the transfer run.
- TransferRun::getScheduleTime() — Method in class TransferRun
- Minimum time after which a transfer run can be started.
- TransferRun::getRunTime() — Method in class TransferRun
- For batch transfer runs, specifies the date and time that data should be ingested.
- TransferRun::getErrorStatus() — Method in class TransferRun
- Status of the transfer run.
- TransferRun::getStartTime() — Method in class TransferRun
- Output only. Time when transfer run was started.
- TransferRun::getEndTime() — Method in class TransferRun
- Output only. Time when transfer run ended.
- TransferRun::getUpdateTime() — Method in class TransferRun
- Output only. Last time the data transfer run state was updated.
- TransferRun::getParams() — Method in class TransferRun
- Output only. Data transfer specific parameters.
- TransferRun::getDestinationDatasetId() — Method in class TransferRun
- Output only. The BigQuery target dataset id.
- TransferRun::getDataSourceId() — Method in class TransferRun
- Output only. Data source id.
- TransferRun::getState() — Method in class TransferRun
- Data transfer run state. Ignored for input requests.
- TransferRun::getUserId() — Method in class TransferRun
- Output only. Unique ID of the user on whose behalf transfer is done.
- TransferRun::getSchedule() — Method in class TransferRun
- Output only. Describes the schedule of this transfer run if it was created as part of a regular schedule. For batch transfer runs that are scheduled manually, this is empty.
- UpdateTransferConfigRequest::getTransferConfig() — Method in class UpdateTransferConfigRequest
- Data transfer configuration to create.
- UpdateTransferConfigRequest::getAuthorizationCode() — Method in class UpdateTransferConfigRequest
- Optional OAuth2 authorization code to use with this transfer configuration.
- UpdateTransferConfigRequest::getUpdateMask() — Method in class UpdateTransferConfigRequest
- Required list of fields to be updated in this request.
- AppProfile::getName() — Method in class AppProfile
- (
OutputOnly) The unique name of the app profile. Values are of the formprojects/<project>/instances/<instance>/appProfiles/[_a-zA-Z0-9][-_.a-zA-Z0-9]*. - AppProfile::getEtag() — Method in class AppProfile
- Strongly validated etag for optimistic concurrency control. Preserve the
value returned from
GetAppProfilewhen callingUpdateAppProfileto fail the request if there has been a modification in the mean time. Theupdate_maskof the request need not includeetagfor this protection to apply. - AppProfile::getDescription() — Method in class AppProfile
- Optional long form description of the use case for this AppProfile.
- AppProfile::getMultiClusterRoutingUseAny() — Method in class AppProfile
- Use a multi-cluster routing policy that may pick any cluster.
- AppProfile::getSingleClusterRouting() — Method in class AppProfile
- Use a single-cluster routing policy.
- AppProfile::getRoutingPolicy() — Method in class AppProfile
- AppProfile_SingleClusterRouting::getClusterId() — Method in class AppProfile_SingleClusterRouting
- The cluster to which read/write requests should be routed.
- AppProfile_SingleClusterRouting::getAllowTransactionalWrites() — Method in class AppProfile_SingleClusterRouting
- Whether or not
CheckAndMutateRowandReadModifyWriteRowrequests are allowed by this app profile. It is unsafe to send these requests to the same table/row/column in multiple clusters. - BigtableInstanceAdminGrpcClient::GetInstance() — Method in class BigtableInstanceAdminGrpcClient
- Gets information about an instance.
- BigtableInstanceAdminGrpcClient::GetCluster() — Method in class BigtableInstanceAdminGrpcClient
- Gets information about a cluster.
- BigtableInstanceAdminGrpcClient::GetAppProfile() — Method in class BigtableInstanceAdminGrpcClient
- Gets information about an app profile.
- BigtableInstanceAdminGrpcClient::GetIamPolicy() — Method in class BigtableInstanceAdminGrpcClient
- Gets the access control policy for an instance resource. Returns an empty policy if an instance exists but does not have a policy set.
- BigtableTableAdminGrpcClient::GetTable() — Method in class BigtableTableAdminGrpcClient
- Gets metadata information about the specified table.
- BigtableTableAdminGrpcClient::GenerateConsistencyToken() — Method in class BigtableTableAdminGrpcClient
- Generates a consistency token for a Table, which can be used in CheckConsistency to check whether mutations to the table that finished before this call started have been replicated. The tokens will be available for 90 days.
- BigtableTableAdminGrpcClient::GetSnapshot() — Method in class BigtableTableAdminGrpcClient
- Gets metadata information about the specified snapshot.
- CheckConsistencyRequest::getName() — Method in class CheckConsistencyRequest
- The unique name of the Table for which to check replication consistency.
- CheckConsistencyRequest::getConsistencyToken() — Method in class CheckConsistencyRequest
- The token created using GenerateConsistencyToken for the Table.
- CheckConsistencyResponse::getConsistent() — Method in class CheckConsistencyResponse
- True only if the token is consistent. A token is consistent if replication has caught up with the restrictions specified in the request.
- Cluster::getName() — Method in class Cluster
- (
OutputOnly) The unique name of the cluster. Values are of the formprojects/<project>/instances/<instance>/clusters/[a-z][-a-z0-9]*. - Cluster::getLocation() — Method in class Cluster
- (
CreationOnly) The location where this cluster's nodes and storage reside. For best performance, clients should be located as close as possible to this cluster. Currently only zones are supported, so values should be of the formprojects/<project>/locations/<zone>. - Cluster::getState() — Method in class Cluster
- (
OutputOnly) The current state of the cluster. - Cluster::getServeNodes() — Method in class Cluster
- The number of nodes allocated to this cluster. More nodes enable higher throughput and more consistent performance.
- Cluster::getDefaultStorageType() — Method in class Cluster
- (
CreationOnly) The type of storage used by this cluster to serve its parent instance's tables, unless explicitly overridden. - ColumnFamily::getGcRule() — Method in class ColumnFamily
- Garbage collection rule specified as a protobuf.
- CreateAppProfileRequest::getParent() — Method in class CreateAppProfileRequest
- The unique name of the instance in which to create the new app profile.
- CreateAppProfileRequest::getAppProfileId() — Method in class CreateAppProfileRequest
- The ID to be used when referring to the new app profile within its
instance, e.g., just
myprofilerather thanprojects/myproject/instances/myinstance/appProfiles/myprofile. - CreateAppProfileRequest::getAppProfile() — Method in class CreateAppProfileRequest
- The app profile to be created.
- CreateAppProfileRequest::getIgnoreWarnings() — Method in class CreateAppProfileRequest
- If true, ignore safety checks when creating the app profile.
- CreateClusterMetadata::getOriginalRequest() — Method in class CreateClusterMetadata
- The request that prompted the initiation of this CreateCluster operation.
- CreateClusterMetadata::getRequestTime() — Method in class CreateClusterMetadata
- The time at which the original request was received.
- CreateClusterMetadata::getFinishTime() — Method in class CreateClusterMetadata
- The time at which the operation failed or was completed successfully.
- CreateClusterRequest::getParent() — Method in class CreateClusterRequest
- The unique name of the instance in which to create the new cluster.
- CreateClusterRequest::getClusterId() — Method in class CreateClusterRequest
- The ID to be used when referring to the new cluster within its instance,
e.g., just
myclusterrather thanprojects/myproject/instances/myinstance/clusters/mycluster. - CreateClusterRequest::getCluster() — Method in class CreateClusterRequest
- The cluster to be created.
- CreateInstanceMetadata::getOriginalRequest() — Method in class CreateInstanceMetadata
- The request that prompted the initiation of this CreateInstance operation.
- CreateInstanceMetadata::getRequestTime() — Method in class CreateInstanceMetadata
- The time at which the original request was received.
- CreateInstanceMetadata::getFinishTime() — Method in class CreateInstanceMetadata
- The time at which the operation failed or was completed successfully.
- CreateInstanceRequest::getParent() — Method in class CreateInstanceRequest
- The unique name of the project in which to create the new instance.
- CreateInstanceRequest::getInstanceId() — Method in class CreateInstanceRequest
- The ID to be used when referring to the new instance within its project,
e.g., just
myinstancerather thanprojects/myproject/instances/myinstance. - CreateInstanceRequest::getInstance() — Method in class CreateInstanceRequest
- The instance to create.
- CreateInstanceRequest::getClusters() — Method in class CreateInstanceRequest
- The clusters to be created within the instance, mapped by desired
cluster ID, e.g., just
myclusterrather thanprojects/myproject/instances/myinstance/clusters/mycluster. - CreateTableFromSnapshotMetadata::getOriginalRequest() — Method in class CreateTableFromSnapshotMetadata
- The request that prompted the initiation of this CreateTableFromSnapshot operation.
- CreateTableFromSnapshotMetadata::getRequestTime() — Method in class CreateTableFromSnapshotMetadata
- The time at which the original request was received.
- CreateTableFromSnapshotMetadata::getFinishTime() — Method in class CreateTableFromSnapshotMetadata
- The time at which the operation failed or was completed successfully.
- CreateTableFromSnapshotRequest::getParent() — Method in class CreateTableFromSnapshotRequest
- The unique name of the instance in which to create the table.
- CreateTableFromSnapshotRequest::getTableId() — Method in class CreateTableFromSnapshotRequest
- The name by which the new table should be referred to within the parent
instance, e.g.,
foobarrather than<parent>/tables/foobar. - CreateTableFromSnapshotRequest::getSourceSnapshot() — Method in class CreateTableFromSnapshotRequest
- The unique name of the snapshot from which to restore the table. The snapshot and the table must be in the same instance.
- CreateTableRequest::getParent() — Method in class CreateTableRequest
- The unique name of the instance in which to create the table.
- CreateTableRequest::getTableId() — Method in class CreateTableRequest
- The name by which the new table should be referred to within the parent
instance, e.g.,
foobarrather than<parent>/tables/foobar. - CreateTableRequest::getTable() — Method in class CreateTableRequest
- The Table to create.
- CreateTableRequest::getInitialSplits() — Method in class CreateTableRequest
- The optional list of row keys that will be used to initially split the table into several tablets (tablets are similar to HBase regions).
- CreateTableRequest_Split::getKey() — Method in class CreateTableRequest_Split
- Row key to use as an initial tablet boundary.
- DeleteAppProfileRequest::getName() — Method in class DeleteAppProfileRequest
- The unique name of the app profile to be deleted. Values are of the form
projects/<project>/instances/<instance>/appProfiles/<app_profile>. - DeleteAppProfileRequest::getIgnoreWarnings() — Method in class DeleteAppProfileRequest
- If true, ignore safety checks when deleting the app profile.
- DeleteClusterRequest::getName() — Method in class DeleteClusterRequest
- The unique name of the cluster to be deleted. Values are of the form
projects/<project>/instances/<instance>/clusters/<cluster>. - DeleteInstanceRequest::getName() — Method in class DeleteInstanceRequest
- The unique name of the instance to be deleted.
- DeleteSnapshotRequest::getName() — Method in class DeleteSnapshotRequest
- The unique name of the snapshot to be deleted.
- DeleteTableRequest::getName() — Method in class DeleteTableRequest
- The unique name of the table to be deleted.
- DropRowRangeRequest::getName() — Method in class DropRowRangeRequest
- The unique name of the table on which to drop a range of rows.
- DropRowRangeRequest::getRowKeyPrefix() — Method in class DropRowRangeRequest
- Delete all rows that start with this row key prefix. Prefix cannot be zero length.
- DropRowRangeRequest::getDeleteAllDataFromTable() — Method in class DropRowRangeRequest
- Delete all rows in the table. Setting this to false is a no-op.
- DropRowRangeRequest::getTarget() — Method in class DropRowRangeRequest
- GcRule — Class in namespace Google\Cloud\Bigtable\Admin\V2
- Rule for determining which cells to delete during garbage collection.
- GcRule::getMaxNumVersions() — Method in class GcRule
- Delete all cells in a column except the most recent N.
- GcRule::getMaxAge() — Method in class GcRule
- Delete cells in a column older than the given age.
- GcRule::getIntersection() — Method in class GcRule
- Delete cells that would be deleted by every nested rule.
- GcRule::getUnion() — Method in class GcRule
- Delete cells that would be deleted by any nested rule.
- GcRule::getRule() — Method in class GcRule
- GcRule_Intersection — Class in namespace Google\Cloud\Bigtable\Admin\V2
- A GcRule which deletes cells matching all of the given rules.
- GcRule_Intersection::getRules() — Method in class GcRule_Intersection
- Only delete cells which would be deleted by every element of
rules. - GcRule_Union — Class in namespace Google\Cloud\Bigtable\Admin\V2
- A GcRule which deletes cells matching any of the given rules.
- GcRule_Union::getRules() — Method in class GcRule_Union
- Delete cells which would be deleted by any element of
rules. - GenerateConsistencyTokenRequest — Class in namespace Google\Cloud\Bigtable\Admin\V2
- Request message for [google.bigtable.admin.v2.BigtableTableAdmin.GenerateConsistencyToken][google.bigtable.admin.v2.BigtableTableAdmin.GenerateConsistencyToken]
- GenerateConsistencyTokenRequest::getName() — Method in class GenerateConsistencyTokenRequest
- The unique name of the Table for which to create a consistency token.
- GenerateConsistencyTokenResponse — Class in namespace Google\Cloud\Bigtable\Admin\V2
- Response message for [google.bigtable.admin.v2.BigtableTableAdmin.GenerateConsistencyToken][google.bigtable.admin.v2.BigtableTableAdmin.GenerateConsistencyToken]
- GenerateConsistencyTokenResponse::getConsistencyToken() — Method in class GenerateConsistencyTokenResponse
- The generated consistency token.
- GetAppProfileRequest — Class in namespace Google\Cloud\Bigtable\Admin\V2
- Request message for BigtableInstanceAdmin.GetAppProfile.
- GetAppProfileRequest::getName() — Method in class GetAppProfileRequest
- The unique name of the requested app profile. Values are of the form
projects/<project>/instances/<instance>/appProfiles/<app_profile>. - GetClusterRequest — Class in namespace Google\Cloud\Bigtable\Admin\V2
- Request message for BigtableInstanceAdmin.GetCluster.
- GetClusterRequest::getName() — Method in class GetClusterRequest
- The unique name of the requested cluster. Values are of the form
projects/<project>/instances/<instance>/clusters/<cluster>. - GetInstanceRequest — Class in namespace Google\Cloud\Bigtable\Admin\V2
- Request message for BigtableInstanceAdmin.GetInstance.
- GetInstanceRequest::getName() — Method in class GetInstanceRequest
- The unique name of the requested instance. Values are of the form
projects/<project>/instances/<instance>. - GetSnapshotRequest — Class in namespace Google\Cloud\Bigtable\Admin\V2
- Request message for [google.bigtable.admin.v2.BigtableTableAdmin.GetSnapshot][google.bigtable.admin.v2.BigtableTableAdmin.GetSnapshot] Note: This is a private alpha release of Cloud Bigtable snapshots. This feature is not currently available to most Cloud Bigtable customers. This feature might be changed in backward-incompatible ways and is not recommended for production use. It is not subject to any SLA or deprecation policy.
- GetSnapshotRequest::getName() — Method in class GetSnapshotRequest
- The unique name of the requested snapshot.
- GetTableRequest — Class in namespace Google\Cloud\Bigtable\Admin\V2
- Request message for [google.bigtable.admin.v2.BigtableTableAdmin.GetTable][google.bigtable.admin.v2.BigtableTableAdmin.GetTable]
- GetTableRequest::getName() — Method in class GetTableRequest
- The unique name of the requested table.
- GetTableRequest::getView() — Method in class GetTableRequest
- The view to be applied to the returned table's fields.
- Instance::getName() — Method in class Instance
- (
OutputOnly) The unique name of the instance. Values are of the formprojects/<project>/instances/[a-z][a-z0-9\\-]+[a-z0-9]. - Instance::getDisplayName() — Method in class Instance
- The descriptive name for this instance as it appears in UIs.
- Instance::getState() — Method in class Instance
- (
OutputOnly) The current state of the instance. - Instance::getType() — Method in class Instance
- The type of the instance. Defaults to
PRODUCTION. - Instance::getLabels() — Method in class Instance
- Labels are a flexible and lightweight mechanism for organizing cloud resources into groups that reflect a customer's organizational needs and deployment strategies. They can be used to filter resources and aggregate metrics.
- ListAppProfilesRequest::getParent() — Method in class ListAppProfilesRequest
- The unique name of the instance for which a list of app profiles is
requested. Values are of the form
projects/<project>/instances/<instance>. - ListAppProfilesRequest::getPageToken() — Method in class ListAppProfilesRequest
- The value of
next_page_tokenreturned by a previous call. - ListAppProfilesResponse::getAppProfiles() — Method in class ListAppProfilesResponse
- The list of requested app profiles.
- ListAppProfilesResponse::getNextPageToken() — Method in class ListAppProfilesResponse
- Set if not all app profiles could be returned in a single response.
- ListClustersRequest::getParent() — Method in class ListClustersRequest
- The unique name of the instance for which a list of clusters is requested.
- ListClustersRequest::getPageToken() — Method in class ListClustersRequest
- The value of
next_page_tokenreturned by a previous call. - ListClustersResponse::getClusters() — Method in class ListClustersResponse
- The list of requested clusters.
- ListClustersResponse::getFailedLocations() — Method in class ListClustersResponse
- Locations from which Cluster information could not be retrieved, due to an outage or some other transient condition.
- ListClustersResponse::getNextPageToken() — Method in class ListClustersResponse
- Set if not all clusters could be returned in a single response.
- ListInstancesRequest::getParent() — Method in class ListInstancesRequest
- The unique name of the project for which a list of instances is requested.
- ListInstancesRequest::getPageToken() — Method in class ListInstancesRequest
- The value of
next_page_tokenreturned by a previous call. - ListInstancesResponse::getInstances() — Method in class ListInstancesResponse
- The list of requested instances.
- ListInstancesResponse::getFailedLocations() — Method in class ListInstancesResponse
- Locations from which Instance information could not be retrieved, due to an outage or some other transient condition.
- ListInstancesResponse::getNextPageToken() — Method in class ListInstancesResponse
- Set if not all instances could be returned in a single response.
- ListSnapshotsRequest::getParent() — Method in class ListSnapshotsRequest
- The unique name of the cluster for which snapshots should be listed.
- ListSnapshotsRequest::getPageSize() — Method in class ListSnapshotsRequest
- The maximum number of snapshots to return.
- ListSnapshotsRequest::getPageToken() — Method in class ListSnapshotsRequest
- The value of
next_page_tokenreturned by a previous call. - ListSnapshotsResponse::getSnapshots() — Method in class ListSnapshotsResponse
- The snapshots present in the requested cluster.
- ListSnapshotsResponse::getNextPageToken() — Method in class ListSnapshotsResponse
- Set if not all snapshots could be returned in a single response.
- ListTablesRequest::getParent() — Method in class ListTablesRequest
- The unique name of the instance for which tables should be listed.
- ListTablesRequest::getView() — Method in class ListTablesRequest
- The view to be applied to the returned tables' fields.
- ListTablesRequest::getPageToken() — Method in class ListTablesRequest
- The value of
next_page_tokenreturned by a previous call. - ListTablesResponse::getTables() — Method in class ListTablesResponse
- The tables present in the requested instance.
- ListTablesResponse::getNextPageToken() — Method in class ListTablesResponse
- Set if not all tables could be returned in a single response.
- ModifyColumnFamiliesRequest::getName() — Method in class ModifyColumnFamiliesRequest
- The unique name of the table whose families should be modified.
- ModifyColumnFamiliesRequest::getModifications() — Method in class ModifyColumnFamiliesRequest
- Modifications to be atomically applied to the specified table's families.
- ModifyColumnFamiliesRequest_Modification::getId() — Method in class ModifyColumnFamiliesRequest_Modification
- The ID of the column family to be modified.
- ModifyColumnFamiliesRequest_Modification::getCreate() — Method in class ModifyColumnFamiliesRequest_Modification
- Create a new column family with the specified schema, or fail if one already exists with the given ID.
- ModifyColumnFamiliesRequest_Modification::getUpdate() — Method in class ModifyColumnFamiliesRequest_Modification
- Update an existing column family to the specified schema, or fail if no column family exists with the given ID.
- ModifyColumnFamiliesRequest_Modification::getDrop() — Method in class ModifyColumnFamiliesRequest_Modification
- Drop (delete) the column family with the given ID, or fail if no such family exists.
- ModifyColumnFamiliesRequest_Modification::getMod() — Method in class ModifyColumnFamiliesRequest_Modification
- PartialUpdateInstanceRequest::getInstance() — Method in class PartialUpdateInstanceRequest
- The Instance which will (partially) replace the current value.
- PartialUpdateInstanceRequest::getUpdateMask() — Method in class PartialUpdateInstanceRequest
- The subset of Instance fields which should be replaced.
- Snapshot::getName() — Method in class Snapshot
- (
OutputOnly) The unique name of the snapshot. - Snapshot::getSourceTable() — Method in class Snapshot
- (
OutputOnly) The source table at the time the snapshot was taken. - Snapshot::getDataSizeBytes() — Method in class Snapshot
- (
OutputOnly) The size of the data in the source table at the time the snapshot was taken. In some cases, this value may be computed asynchronously via a background process and a placeholder of 0 will be used in the meantime. - Snapshot::getCreateTime() — Method in class Snapshot
- (
OutputOnly) The time when the snapshot is created. - Snapshot::getDeleteTime() — Method in class Snapshot
- (
OutputOnly) The time when the snapshot will be deleted. The maximum amount of time a snapshot can stay active is 365 days. If 'ttl' is not specified, the default maximum of 365 days will be used. - Snapshot::getState() — Method in class Snapshot
- (
OutputOnly) The current state of the snapshot. - Snapshot::getDescription() — Method in class Snapshot
- (
OutputOnly) Description of the snapshot. - SnapshotTableMetadata::getOriginalRequest() — Method in class SnapshotTableMetadata
- The request that prompted the initiation of this SnapshotTable operation.
- SnapshotTableMetadata::getRequestTime() — Method in class SnapshotTableMetadata
- The time at which the original request was received.
- SnapshotTableMetadata::getFinishTime() — Method in class SnapshotTableMetadata
- The time at which the operation failed or was completed successfully.
- SnapshotTableRequest::getName() — Method in class SnapshotTableRequest
- The unique name of the table to have the snapshot taken.
- SnapshotTableRequest::getCluster() — Method in class SnapshotTableRequest
- The name of the cluster where the snapshot will be created in.
- SnapshotTableRequest::getSnapshotId() — Method in class SnapshotTableRequest
- The ID by which the new snapshot should be referred to within the parent
cluster, e.g.,
mysnapshotof the form:[_a-zA-Z0-9][-_.a-zA-Z0-9]*rather thanprojects/<project>/instances/<instance>/clusters/<cluster>/snapshots/mysnapshot. - SnapshotTableRequest::getTtl() — Method in class SnapshotTableRequest
- The amount of time that the new snapshot can stay active after it is created. Once 'ttl' expires, the snapshot will get deleted. The maximum amount of time a snapshot can stay active is 7 days. If 'ttl' is not specified, the default value of 24 hours will be used.
- SnapshotTableRequest::getDescription() — Method in class SnapshotTableRequest
- Description of the snapshot.
- Table::getName() — Method in class Table
- (
OutputOnly) The unique name of the table. Values are of the formprojects/<project>/instances/<instance>/tables/[_a-zA-Z0-9][-_.a-zA-Z0-9]*. - Table::getClusterStates() — Method in class Table
- (
OutputOnly) Map from cluster ID to per-cluster table state. - Table::getColumnFamilies() — Method in class Table
- (
CreationOnly) The column families configured for this table, mapped by column family ID. - Table::getGranularity() — Method in class Table
- (
CreationOnly) The granularity (i.e.MILLIS) at which timestamps are stored in this table. Timestamps not matching the granularity will be rejected. - Table_ClusterState::getReplicationState() — Method in class Table_ClusterState
- (
OutputOnly) The state of replication for the table in this cluster. - UpdateAppProfileRequest::getAppProfile() — Method in class UpdateAppProfileRequest
- The app profile which will (partially) replace the current value.
- UpdateAppProfileRequest::getUpdateMask() — Method in class UpdateAppProfileRequest
- The subset of app profile fields which should be replaced.
- UpdateAppProfileRequest::getIgnoreWarnings() — Method in class UpdateAppProfileRequest
- If true, ignore safety checks when updating the app profile.
- UpdateClusterMetadata::getOriginalRequest() — Method in class UpdateClusterMetadata
- The request that prompted the initiation of this UpdateCluster operation.
- UpdateClusterMetadata::getRequestTime() — Method in class UpdateClusterMetadata
- The time at which the original request was received.
- UpdateClusterMetadata::getFinishTime() — Method in class UpdateClusterMetadata
- The time at which the operation failed or was completed successfully.
- UpdateInstanceMetadata::getOriginalRequest() — Method in class UpdateInstanceMetadata
- The request that prompted the initiation of this UpdateInstance operation.
- UpdateInstanceMetadata::getRequestTime() — Method in class UpdateInstanceMetadata
- The time at which the original request was received.
- UpdateInstanceMetadata::getFinishTime() — Method in class UpdateInstanceMetadata
- The time at which the operation failed or was completed successfully.
- Cell::getTimestampMicros() — Method in class Cell
- The cell's stored timestamp, which also uniquely identifies it within its column.
- Cell::getValue() — Method in class Cell
- The value stored in the cell.
- Cell::getLabels() — Method in class Cell
- Labels applied to the cell by a [RowFilter][google.bigtable.v2.RowFilter].
- CheckAndMutateRowRequest::getTableName() — Method in class CheckAndMutateRowRequest
- The unique name of the table to which the conditional mutation should be applied.
- CheckAndMutateRowRequest::getAppProfileId() — Method in class CheckAndMutateRowRequest
- This value specifies routing for replication. If not specified, the "default" application profile will be used.
- CheckAndMutateRowRequest::getRowKey() — Method in class CheckAndMutateRowRequest
- The key of the row to which the conditional mutation should be applied.
- CheckAndMutateRowRequest::getPredicateFilter() — Method in class CheckAndMutateRowRequest
- The filter to be applied to the contents of the specified row. Depending
on whether or not any results are yielded, either
true_mutationsorfalse_mutationswill be executed. If unset, checks that the row contains any values at all. - CheckAndMutateRowRequest::getTrueMutations() — Method in class CheckAndMutateRowRequest
- Changes to be atomically applied to the specified row if
predicate_filteryields at least one cell when applied torow_key. Entries are applied in order, meaning that earlier mutations can be masked by later ones. - CheckAndMutateRowRequest::getFalseMutations() — Method in class CheckAndMutateRowRequest
- Changes to be atomically applied to the specified row if
predicate_filterdoes not yield any cells when applied torow_key. Entries are applied in order, meaning that earlier mutations can be masked by later ones. - CheckAndMutateRowResponse::getPredicateMatched() — Method in class CheckAndMutateRowResponse
- Whether or not the request's
predicate_filteryielded any results for the specified row. - Column::getQualifier() — Method in class Column
- The unique key which identifies this column within its family. This is the
same key that's used to identify the column in, for example, a RowFilter
which sets its
column_qualifier_regex_filterfield. - Column::getCells() — Method in class Column
- Must not be empty. Sorted in order of decreasing "timestamp_micros".
- ColumnRange::getFamilyName() — Method in class ColumnRange
- The name of the column family within which this range falls.
- ColumnRange::getStartQualifierClosed() — Method in class ColumnRange
- Used when giving an inclusive lower bound for the range.
- ColumnRange::getStartQualifierOpen() — Method in class ColumnRange
- Used when giving an exclusive lower bound for the range.
- ColumnRange::getEndQualifierClosed() — Method in class ColumnRange
- Used when giving an inclusive upper bound for the range.
- ColumnRange::getEndQualifierOpen() — Method in class ColumnRange
- Used when giving an exclusive upper bound for the range.
- ColumnRange::getStartQualifier() — Method in class ColumnRange
- ColumnRange::getEndQualifier() — Method in class ColumnRange
- Family::getName() — Method in class Family
- The unique key which identifies this family within its row. This is the same key that's used to identify the family in, for example, a RowFilter which sets its "family_name_regex_filter" field.
- Family::getColumns() — Method in class Family
- Must not be empty. Sorted in order of increasing "qualifier".
- MutateRowRequest::getTableName() — Method in class MutateRowRequest
- The unique name of the table to which the mutation should be applied.
- MutateRowRequest::getAppProfileId() — Method in class MutateRowRequest
- This value specifies routing for replication. If not specified, the "default" application profile will be used.
- MutateRowRequest::getRowKey() — Method in class MutateRowRequest
- The key of the row to which the mutation should be applied.
- MutateRowRequest::getMutations() — Method in class MutateRowRequest
- Changes to be atomically applied to the specified row. Entries are applied in order, meaning that earlier mutations can be masked by later ones.
- MutateRowsRequest::getTableName() — Method in class MutateRowsRequest
- The unique name of the table to which the mutations should be applied.
- MutateRowsRequest::getAppProfileId() — Method in class MutateRowsRequest
- This value specifies routing for replication. If not specified, the "default" application profile will be used.
- MutateRowsRequest::getEntries() — Method in class MutateRowsRequest
- The row keys and corresponding mutations to be applied in bulk.
- MutateRowsRequest_Entry::getRowKey() — Method in class MutateRowsRequest_Entry
- The key of the row to which the
mutationsshould be applied. - MutateRowsRequest_Entry::getMutations() — Method in class MutateRowsRequest_Entry
- Changes to be atomically applied to the specified row. Mutations are applied in order, meaning that earlier mutations can be masked by later ones.
- MutateRowsResponse::getEntries() — Method in class MutateRowsResponse
- One or more results for Entries from the batch request.
- MutateRowsResponse_Entry::getIndex() — Method in class MutateRowsResponse_Entry
- The index into the original request's
entrieslist of the Entry for which a result is being reported. - MutateRowsResponse_Entry::getStatus() — Method in class MutateRowsResponse_Entry
- The result of the request Entry identified by
index. - Mutation::getSetCell() — Method in class Mutation
- Set a cell's value.
- Mutation::getDeleteFromColumn() — Method in class Mutation
- Deletes cells from a column.
- Mutation::getDeleteFromFamily() — Method in class Mutation
- Deletes cells from a column family.
- Mutation::getDeleteFromRow() — Method in class Mutation
- Deletes cells from the entire row.
- Mutation::getMutation() — Method in class Mutation
- Mutation_DeleteFromColumn::getFamilyName() — Method in class Mutation_DeleteFromColumn
- The name of the family from which cells should be deleted.
- Mutation_DeleteFromColumn::getColumnQualifier() — Method in class Mutation_DeleteFromColumn
- The qualifier of the column from which cells should be deleted.
- Mutation_DeleteFromColumn::getTimeRange() — Method in class Mutation_DeleteFromColumn
- The range of timestamps within which cells should be deleted.
- Mutation_DeleteFromFamily::getFamilyName() — Method in class Mutation_DeleteFromFamily
- The name of the family from which cells should be deleted.
- Mutation_SetCell::getFamilyName() — Method in class Mutation_SetCell
- The name of the family into which new data should be written.
- Mutation_SetCell::getColumnQualifier() — Method in class Mutation_SetCell
- The qualifier of the column into which new data should be written.
- Mutation_SetCell::getTimestampMicros() — Method in class Mutation_SetCell
- The timestamp of the cell into which new data should be written.
- Mutation_SetCell::getValue() — Method in class Mutation_SetCell
- The value to be written into the specified cell.
- ReadModifyWriteRowRequest::getTableName() — Method in class ReadModifyWriteRowRequest
- The unique name of the table to which the read/modify/write rules should be applied.
- ReadModifyWriteRowRequest::getAppProfileId() — Method in class ReadModifyWriteRowRequest
- This value specifies routing for replication. If not specified, the "default" application profile will be used.
- ReadModifyWriteRowRequest::getRowKey() — Method in class ReadModifyWriteRowRequest
- The key of the row to which the read/modify/write rules should be applied.
- ReadModifyWriteRowRequest::getRules() — Method in class ReadModifyWriteRowRequest
- Rules specifying how the specified row's contents are to be transformed into writes. Entries are applied in order, meaning that earlier rules will affect the results of later ones.
- ReadModifyWriteRowResponse::getRow() — Method in class ReadModifyWriteRowResponse
- A Row containing the new contents of all cells modified by the request.
- ReadModifyWriteRule::getFamilyName() — Method in class ReadModifyWriteRule
- The name of the family to which the read/modify/write should be applied.
- ReadModifyWriteRule::getColumnQualifier() — Method in class ReadModifyWriteRule
- The qualifier of the column to which the read/modify/write should be applied.
- ReadModifyWriteRule::getAppendValue() — Method in class ReadModifyWriteRule
- Rule specifying that
append_valuebe appended to the existing value. - ReadModifyWriteRule::getIncrementAmount() — Method in class ReadModifyWriteRule
- Rule specifying that
increment_amountbe added to the existing value. - ReadModifyWriteRule::getRule() — Method in class ReadModifyWriteRule
- ReadRowsRequest::getTableName() — Method in class ReadRowsRequest
- The unique name of the table from which to read.
- ReadRowsRequest::getAppProfileId() — Method in class ReadRowsRequest
- This value specifies routing for replication. If not specified, the "default" application profile will be used.
- ReadRowsRequest::getRows() — Method in class ReadRowsRequest
- The row keys and/or ranges to read. If not specified, reads from all rows.
- ReadRowsRequest::getFilter() — Method in class ReadRowsRequest
- The filter to apply to the contents of the specified row(s). If unset, reads the entirety of each row.
- ReadRowsRequest::getRowsLimit() — Method in class ReadRowsRequest
- The read will terminate after committing to N rows' worth of results. The default (zero) is to return all results.
- ReadRowsResponse::getChunks() — Method in class ReadRowsResponse
- Generated from protobuf field
repeated .google.bigtable.v2.ReadRowsResponse.CellChunk chunks = 1; - ReadRowsResponse::getLastScannedRowKey() — Method in class ReadRowsResponse
- Optionally the server might return the row key of the last row it has scanned. The client can use this to construct a more efficient retry request if needed: any row keys or portions of ranges less than this row key can be dropped from the request.
- ReadRowsResponse_CellChunk::getRowKey() — Method in class ReadRowsResponse_CellChunk
- The row key for this chunk of data. If the row key is empty, this CellChunk is a continuation of the same row as the previous CellChunk in the response stream, even if that CellChunk was in a previous ReadRowsResponse message.
- ReadRowsResponse_CellChunk::getFamilyName() — Method in class ReadRowsResponse_CellChunk
- The column family name for this chunk of data. If this message
is not present this CellChunk is a continuation of the same column
family as the previous CellChunk. The empty string can occur as a
column family name in a response so clients must check
explicitly for the presence of this message, not just for
family_name.valuebeing non-empty. - ReadRowsResponse_CellChunk::getQualifier() — Method in class ReadRowsResponse_CellChunk
- The column qualifier for this chunk of data. If this message
is not present, this CellChunk is a continuation of the same column
as the previous CellChunk. Column qualifiers may be empty so
clients must check for the presence of this message, not just
for
qualifier.valuebeing non-empty. - ReadRowsResponse_CellChunk::getTimestampMicros() — Method in class ReadRowsResponse_CellChunk
- The cell's stored timestamp, which also uniquely identifies it
within its column. Values are always expressed in
microseconds, but individual tables may set a coarser
granularity to further restrict the allowed values. For
example, a table which specifies millisecond granularity will
only allow values of
timestamp_microswhich are multiples of 1000. Timestamps are only set in the first CellChunk per cell (for cells split into multiple chunks). - ReadRowsResponse_CellChunk::getLabels() — Method in class ReadRowsResponse_CellChunk
- Labels applied to the cell by a [RowFilter][google.bigtable.v2.RowFilter]. Labels are only set on the first CellChunk per cell.
- ReadRowsResponse_CellChunk::getValue() — Method in class ReadRowsResponse_CellChunk
- The value stored in the cell. Cell values can be split across multiple CellChunks. In that case only the value field will be set in CellChunks after the first: the timestamp and labels will only be present in the first CellChunk, even if the first CellChunk came in a previous ReadRowsResponse.
- ReadRowsResponse_CellChunk::getValueSize() — Method in class ReadRowsResponse_CellChunk
- If this CellChunk is part of a chunked cell value and this is not the final chunk of that cell, value_size will be set to the total length of the cell value. The client can use this size to pre-allocate memory to hold the full cell value.
- ReadRowsResponse_CellChunk::getResetRow() — Method in class ReadRowsResponse_CellChunk
- Indicates that the client should drop all previous chunks for
row_key, as it will be re-read from the beginning. - ReadRowsResponse_CellChunk::getCommitRow() — Method in class ReadRowsResponse_CellChunk
- Indicates that the client can safely process all previous chunks for
row_key, as its data has been fully read. - ReadRowsResponse_CellChunk::getRowStatus() — Method in class ReadRowsResponse_CellChunk
- Row::getKey() — Method in class Row
- The unique key which identifies this row within its table. This is the same key that's used to identify the row in, for example, a MutateRowRequest.
- Row::getFamilies() — Method in class Row
- May be empty, but only if the entire row is empty.
- RowFilter::getChain() — Method in class RowFilter
- Applies several RowFilters to the data in sequence, progressively narrowing the results.
- RowFilter::getInterleave() — Method in class RowFilter
- Applies several RowFilters to the data in parallel and combines the results.
- RowFilter::getCondition() — Method in class RowFilter
- Applies one of two possible RowFilters to the data based on the output of a predicate RowFilter.
- RowFilter::getSink() — Method in class RowFilter
- ADVANCED USE ONLY.
- RowFilter::getPassAllFilter() — Method in class RowFilter
- Matches all cells, regardless of input. Functionally equivalent to
leaving
filterunset, but included for completeness. - RowFilter::getBlockAllFilter() — Method in class RowFilter
- Does not match any cells, regardless of input. Useful for temporarily disabling just part of a filter.
- RowFilter::getRowKeyRegexFilter() — Method in class RowFilter
- Matches only cells from rows whose keys satisfy the given RE2 regex. In other words, passes through the entire row when the key matches, and otherwise produces an empty row.
- RowFilter::getRowSampleFilter() — Method in class RowFilter
- Matches all cells from a row with probability p, and matches no cells from the row with probability 1-p.
- RowFilter::getFamilyNameRegexFilter() — Method in class RowFilter
- Matches only cells from columns whose families satisfy the given RE2
regex. For technical reasons, the regex must not contain the
:character, even if it is not being used as a literal. - RowFilter::getColumnQualifierRegexFilter() — Method in class RowFilter
- Matches only cells from columns whose qualifiers satisfy the given RE2 regex.
- RowFilter::getColumnRangeFilter() — Method in class RowFilter
- Matches only cells from columns within the given range.
- RowFilter::getTimestampRangeFilter() — Method in class RowFilter
- Matches only cells with timestamps within the given range.
- RowFilter::getValueRegexFilter() — Method in class RowFilter
- Matches only cells with values that satisfy the given regular expression.
- RowFilter::getValueRangeFilter() — Method in class RowFilter
- Matches only cells with values that fall within the given range.
- RowFilter::getCellsPerRowOffsetFilter() — Method in class RowFilter
- Skips the first N cells of each row, matching all subsequent cells.
- RowFilter::getCellsPerRowLimitFilter() — Method in class RowFilter
- Matches only the first N cells of each row.
- RowFilter::getCellsPerColumnLimitFilter() — Method in class RowFilter
- Matches only the most recent N cells within each column. For example,
if N=2, this filter would match column
foo:barat timestamps 10 and 9, skip all earlier cells infoo:bar, and then begin matching again in columnfoo:bar2. - RowFilter::getStripValueTransformer() — Method in class RowFilter
- Replaces each cell's value with the empty string.
- RowFilter::getApplyLabelTransformer() — Method in class RowFilter
- Applies the given label to all cells in the output row. This allows the client to determine which results were produced from which part of the filter.
- RowFilter::getFilter() — Method in class RowFilter
- RowFilter_Chain::getFilters() — Method in class RowFilter_Chain
- The elements of "filters" are chained together to process the input row: in row -> f(0) -> intermediate row -> f(1) -> .
- RowFilter_Condition::getPredicateFilter() — Method in class RowFilter_Condition
- If
predicate_filteroutputs any cells, thentrue_filterwill be evaluated on the input row. Otherwise,false_filterwill be evaluated. - RowFilter_Condition::getTrueFilter() — Method in class RowFilter_Condition
- The filter to apply to the input row if
predicate_filterreturns any results. If not provided, no results will be returned in the true case. - RowFilter_Condition::getFalseFilter() — Method in class RowFilter_Condition
- The filter to apply to the input row if
predicate_filterdoes not return any results. If not provided, no results will be returned in the false case. - RowFilter_Interleave::getFilters() — Method in class RowFilter_Interleave
- The elements of "filters" all process a copy of the input row, and the results are pooled, sorted, and combined into a single output row.
- RowRange::getStartKeyClosed() — Method in class RowRange
- Used when giving an inclusive lower bound for the range.
- RowRange::getStartKeyOpen() — Method in class RowRange
- Used when giving an exclusive lower bound for the range.
- RowRange::getEndKeyOpen() — Method in class RowRange
- Used when giving an exclusive upper bound for the range.
- RowRange::getEndKeyClosed() — Method in class RowRange
- Used when giving an inclusive upper bound for the range.
- RowRange::getStartKey() — Method in class RowRange
- RowRange::getEndKey() — Method in class RowRange
- RowSet::getRowKeys() — Method in class RowSet
- Single rows included in the set.
- RowSet::getRowRanges() — Method in class RowSet
- Contiguous row ranges included in the set.
- SampleRowKeysRequest::getTableName() — Method in class SampleRowKeysRequest
- The unique name of the table from which to sample row keys.
- SampleRowKeysRequest::getAppProfileId() — Method in class SampleRowKeysRequest
- This value specifies routing for replication. If not specified, the "default" application profile will be used.
- SampleRowKeysResponse::getRowKey() — Method in class SampleRowKeysResponse
- Sorted streamed sequence of sample row keys in the table. The table might have contents before the first row key in the list and after the last one, but a key containing the empty string indicates "end of table" and will be the last response given, if present.
- SampleRowKeysResponse::getOffsetBytes() — Method in class SampleRowKeysResponse
- Approximate total storage space used by all rows in the table which precede
row_key. Buffering the contents of all rows between two subsequent samples would require space roughly equal to the difference in theiroffset_bytesfields. - TimestampRange::getStartTimestampMicros() — Method in class TimestampRange
- Inclusive lower bound. If left empty, interpreted as 0.
- TimestampRange::getEndTimestampMicros() — Method in class TimestampRange
- Exclusive upper bound. If left empty, interpreted as infinity.
- ValueRange::getStartValueClosed() — Method in class ValueRange
- Used when giving an inclusive lower bound for the range.
- ValueRange::getStartValueOpen() — Method in class ValueRange
- Used when giving an exclusive lower bound for the range.
- ValueRange::getEndValueClosed() — Method in class ValueRange
- Used when giving an inclusive upper bound for the range.
- ValueRange::getEndValueOpen() — Method in class ValueRange
- Used when giving an exclusive upper bound for the range.
- ValueRange::getStartValue() — Method in class ValueRange
- ValueRange::getEndValue() — Method in class ValueRange
- AcceleratorConfig::getAcceleratorCount() — Method in class AcceleratorConfig
- The number of the accelerator cards exposed to an instance.
- AcceleratorConfig::getAcceleratorType() — Method in class AcceleratorConfig
- The accelerator type resource name. List of supported accelerators here
- AddonsConfig::getHttpLoadBalancing() — Method in class AddonsConfig
- Configuration for the HTTP (L7) load balancing controller addon, which makes it easy to set up HTTP load balancers for services in a cluster.
- AddonsConfig::getHorizontalPodAutoscaling() — Method in class AddonsConfig
- Configuration for the horizontal pod autoscaling feature, which increases or decreases the number of replica pods a replication controller has based on the resource usage of the existing pods.
- AddonsConfig::getKubernetesDashboard() — Method in class AddonsConfig
- Configuration for the Kubernetes Dashboard.
- AddonsConfig::getNetworkPolicyConfig() — Method in class AddonsConfig
- Configuration for NetworkPolicy. This only tracks whether the addon is enabled or not on the Master, it does not track whether network policy is enabled for the nodes.
- AutoUpgradeOptions::getAutoUpgradeStartTime() — Method in class AutoUpgradeOptions
- [Output only] This field is set when upgrades are about to commence with the approximate start time for the upgrades, in RFC3339 text format.
- AutoUpgradeOptions::getDescription() — Method in class AutoUpgradeOptions
- [Output only] This field is set when upgrades are about to commence with the description of the upgrade.
- CancelOperationRequest::getProjectId() — Method in class CancelOperationRequest
- The Google Developers Console project ID or project number.
- CancelOperationRequest::getZone() — Method in class CancelOperationRequest
- The name of the Google Compute Engine zone in which the operation resides.
- CancelOperationRequest::getOperationId() — Method in class CancelOperationRequest
- The server-assigned
nameof the operation. - ClientCertificateConfig::getIssueClientCertificate() — Method in class ClientCertificateConfig
- Issue a client certificate.
- Cluster::getName() — Method in class Cluster
- The name of this cluster. The name must be unique within this project and zone, and can be up to 40 characters with the following restrictions: * Lowercase letters, numbers, and hyphens only.
- Cluster::getDescription() — Method in class Cluster
- An optional description of this cluster.
- Cluster::getInitialNodeCount() — Method in class Cluster
- The number of nodes to create in this cluster. You must ensure that your Compute Engine resource quota is sufficient for this number of instances. You must also have available firewall and routes quota.
- Cluster::getNodeConfig() — Method in class Cluster
- Parameters used in creating the cluster's nodes.
- Cluster::getMasterAuth() — Method in class Cluster
- The authentication information for accessing the master endpoint.
- Cluster::getLoggingService() — Method in class Cluster
- The logging service the cluster should use to write logs.
- Cluster::getMonitoringService() — Method in class Cluster
- The monitoring service the cluster should use to write metrics.
- Cluster::getNetwork() — Method in class Cluster
- The name of the Google Compute Engine
network to which the
cluster is connected. If left unspecified, the
defaultnetwork will be used. - Cluster::getClusterIpv4Cidr() — Method in class Cluster
- The IP address range of the container pods in this cluster, in
CIDR
notation (e.g.
10.96.0.0/14). Leave blank to have one automatically chosen or specify a/14block in10.0.0.0/8. - Cluster::getAddonsConfig() — Method in class Cluster
- Configurations for the various addons available to run in the cluster.
- Cluster::getSubnetwork() — Method in class Cluster
- The name of the Google Compute Engine subnetwork to which the cluster is connected.
- Cluster::getNodePools() — Method in class Cluster
- The node pools associated with this cluster.
- Cluster::getLocations() — Method in class Cluster
- The list of Google Compute Engine locations in which the cluster's nodes should be located.
- Cluster::getEnableKubernetesAlpha() — Method in class Cluster
- Kubernetes alpha features are enabled on this cluster. This includes alpha API groups (e.g. v1alpha1) and features that may not be production ready in the kubernetes version of the master and nodes.
- Cluster::getResourceLabels() — Method in class Cluster
- The resource labels for the cluster to use to annotate any related Google Compute Engine resources.
- Cluster::getLabelFingerprint() — Method in class Cluster
- The fingerprint of the set of labels for this cluster.
- Cluster::getLegacyAbac() — Method in class Cluster
- Configuration for the legacy ABAC authorization mode.
- Cluster::getNetworkPolicy() — Method in class Cluster
- Configuration options for the NetworkPolicy feature.
- Cluster::getIpAllocationPolicy() — Method in class Cluster
- Configuration for cluster IP allocation.
- Cluster::getMasterAuthorizedNetworksConfig() — Method in class Cluster
- Master authorized networks is a Beta feature.
- Cluster::getMaintenancePolicy() — Method in class Cluster
- Configure the maintenance policy for this cluster.
- Cluster::getSelfLink() — Method in class Cluster
- [Output only] Server-defined URL for the resource.
- Cluster::getZone() — Method in class Cluster
- [Output only] The name of the Google Compute Engine zone in which the cluster resides.
- Cluster::getEndpoint() — Method in class Cluster
- [Output only] The IP address of this cluster's master endpoint.
- Cluster::getInitialClusterVersion() — Method in class Cluster
- The initial Kubernetes version for this cluster. Valid versions are those found in validMasterVersions returned by getServerConfig. The version can be upgraded over time; such upgrades are reflected in currentMasterVersion and currentNodeVersion.
- Cluster::getCurrentMasterVersion() — Method in class Cluster
- [Output only] The current software version of the master endpoint.
- Cluster::getCurrentNodeVersion() — Method in class Cluster
- [Output only] The current version of the node software components.
- Cluster::getCreateTime() — Method in class Cluster
- [Output only] The time the cluster was created, in RFC3339 text format.
- Cluster::getStatus() — Method in class Cluster
- [Output only] The current status of this cluster.
- Cluster::getStatusMessage() — Method in class Cluster
- [Output only] Additional information about the current status of this cluster, if available.
- Cluster::getNodeIpv4CidrSize() — Method in class Cluster
- [Output only] The size of the address space on each node for hosting
containers. This is provisioned from within the
container_ipv4_cidrrange. - Cluster::getServicesIpv4Cidr() — Method in class Cluster
- [Output only] The IP address range of the Kubernetes services in
this cluster, in
CIDR
notation (e.g.
1.2.3.4/29). Service addresses are typically put in the last/16from the container CIDR. - Cluster::getInstanceGroupUrls() — Method in class Cluster
- Deprecated. Use node_pools.instance_group_urls.
- Cluster::getCurrentNodeCount() — Method in class Cluster
- [Output only] The number of nodes currently in the cluster.
- Cluster::getExpireTime() — Method in class Cluster
- [Output only] The time the cluster will be automatically deleted in RFC3339 text format.
- ClusterManagerGrpcClient::GetCluster() — Method in class ClusterManagerGrpcClient
- Gets the details of a specific cluster.
- ClusterManagerGrpcClient::GetOperation() — Method in class ClusterManagerGrpcClient
- Gets the specified operation.
- ClusterManagerGrpcClient::GetServerConfig() — Method in class ClusterManagerGrpcClient
- Returns configuration info about the Container Engine service.
- ClusterManagerGrpcClient::GetNodePool() — Method in class ClusterManagerGrpcClient
- Retrieves the node pool requested.
- ClusterUpdate::getDesiredNodeVersion() — Method in class ClusterUpdate
- The Kubernetes version to change the nodes to (typically an
upgrade). Use
-to upgrade to the latest version supported by the server. - ClusterUpdate::getDesiredMonitoringService() — Method in class ClusterUpdate
- The monitoring service the cluster should use to write metrics.
- ClusterUpdate::getDesiredAddonsConfig() — Method in class ClusterUpdate
- Configurations for the various addons available to run in the cluster.
- ClusterUpdate::getDesiredNodePoolId() — Method in class ClusterUpdate
- The node pool to be upgraded. This field is mandatory if "desired_node_version", "desired_image_family" or "desired_node_pool_autoscaling" is specified and there is more than one node pool on the cluster.
- ClusterUpdate::getDesiredImageType() — Method in class ClusterUpdate
- The desired image type for the node pool.
- ClusterUpdate::getDesiredNodePoolAutoscaling() — Method in class ClusterUpdate
- Autoscaler configuration for the node pool specified in desired_node_pool_id. If there is only one pool in the cluster and desired_node_pool_id is not provided then the change applies to that single node pool.
- ClusterUpdate::getDesiredLocations() — Method in class ClusterUpdate
- The desired list of Google Compute Engine locations in which the cluster's nodes should be located. Changing the locations a cluster is in will result in nodes being either created or removed from the cluster, depending on whether locations are being added or removed.
- ClusterUpdate::getDesiredMasterAuthorizedNetworksConfig() — Method in class ClusterUpdate
- Master authorized networks is a Beta feature.
- ClusterUpdate::getDesiredMasterVersion() — Method in class ClusterUpdate
- The Kubernetes version to change the master to. The only valid value is the latest supported version. Use "-" to have the server automatically select the latest version.
- CompleteIPRotationRequest::getProjectId() — Method in class CompleteIPRotationRequest
- The Google Developers Console project ID or project number.
- CompleteIPRotationRequest::getZone() — Method in class CompleteIPRotationRequest
- The name of the Google Compute Engine zone in which the cluster resides.
- CompleteIPRotationRequest::getClusterId() — Method in class CompleteIPRotationRequest
- The name of the cluster.
- CreateClusterRequest::getProjectId() — Method in class CreateClusterRequest
- The Google Developers Console project ID or project number.
- CreateClusterRequest::getZone() — Method in class CreateClusterRequest
- The name of the Google Compute Engine zone in which the cluster resides.
- CreateClusterRequest::getCluster() — Method in class CreateClusterRequest
- A cluster resource
- CreateNodePoolRequest::getProjectId() — Method in class CreateNodePoolRequest
- The Google Developers Console project ID or project number.
- CreateNodePoolRequest::getZone() — Method in class CreateNodePoolRequest
- The name of the Google Compute Engine zone in which the cluster resides.
- CreateNodePoolRequest::getClusterId() — Method in class CreateNodePoolRequest
- The name of the cluster.
- CreateNodePoolRequest::getNodePool() — Method in class CreateNodePoolRequest
- The node pool to create.
- DailyMaintenanceWindow::getStartTime() — Method in class DailyMaintenanceWindow
- Time within the maintenance window to start the maintenance operations.
- DailyMaintenanceWindow::getDuration() — Method in class DailyMaintenanceWindow
- [Output only] Duration of the time window, automatically chosen to be smallest possible in the given scenario.
- DeleteClusterRequest::getProjectId() — Method in class DeleteClusterRequest
- The Google Developers Console project ID or project number.
- DeleteClusterRequest::getZone() — Method in class DeleteClusterRequest
- The name of the Google Compute Engine zone in which the cluster resides.
- DeleteClusterRequest::getClusterId() — Method in class DeleteClusterRequest
- The name of the cluster to delete.
- DeleteNodePoolRequest::getProjectId() — Method in class DeleteNodePoolRequest
- The Google Developers Console project ID or project number.
- DeleteNodePoolRequest::getZone() — Method in class DeleteNodePoolRequest
- The name of the Google Compute Engine zone in which the cluster resides.
- DeleteNodePoolRequest::getClusterId() — Method in class DeleteNodePoolRequest
- The name of the cluster.
- DeleteNodePoolRequest::getNodePoolId() — Method in class DeleteNodePoolRequest
- The name of the node pool to delete.
- GetClusterRequest — Class in namespace Google\Cloud\Container\V1
- GetClusterRequest gets the settings of a cluster.
- GetClusterRequest::getProjectId() — Method in class GetClusterRequest
- The Google Developers Console project ID or project number.
- GetClusterRequest::getZone() — Method in class GetClusterRequest
- The name of the Google Compute Engine zone in which the cluster resides.
- GetClusterRequest::getClusterId() — Method in class GetClusterRequest
- The name of the cluster to retrieve.
- GetNodePoolRequest — Class in namespace Google\Cloud\Container\V1
- GetNodePoolRequest retrieves a node pool for a cluster.
- GetNodePoolRequest::getProjectId() — Method in class GetNodePoolRequest
- The Google Developers Console project ID or project number.
- GetNodePoolRequest::getZone() — Method in class GetNodePoolRequest
- The name of the Google Compute Engine zone in which the cluster resides.
- GetNodePoolRequest::getClusterId() — Method in class GetNodePoolRequest
- The name of the cluster.
- GetNodePoolRequest::getNodePoolId() — Method in class GetNodePoolRequest
- The name of the node pool.
- GetOperationRequest — Class in namespace Google\Cloud\Container\V1
- GetOperationRequest gets a single operation.
- GetOperationRequest::getProjectId() — Method in class GetOperationRequest
- The Google Developers Console project ID or project number.
- GetOperationRequest::getZone() — Method in class GetOperationRequest
- The name of the Google Compute Engine zone in which the cluster resides.
- GetOperationRequest::getOperationId() — Method in class GetOperationRequest
- The server-assigned
nameof the operation. - GetServerConfigRequest — Class in namespace Google\Cloud\Container\V1
- Gets the current Container Engine service configuration.
- GetServerConfigRequest::getProjectId() — Method in class GetServerConfigRequest
- The Google Developers Console project ID or project number.
- GetServerConfigRequest::getZone() — Method in class GetServerConfigRequest
- The name of the Google Compute Engine zone to return operations for.
- HorizontalPodAutoscaling::getDisabled() — Method in class HorizontalPodAutoscaling
- Whether the Horizontal Pod Autoscaling feature is enabled in the cluster.
- HttpLoadBalancing::getDisabled() — Method in class HttpLoadBalancing
- Whether the HTTP Load Balancing controller is enabled in the cluster.
- IPAllocationPolicy::getUseIpAliases() — Method in class IPAllocationPolicy
- Whether alias IPs will be used for pod IPs in the cluster.
- IPAllocationPolicy::getCreateSubnetwork() — Method in class IPAllocationPolicy
- Whether a new subnetwork will be created automatically for the cluster.
- IPAllocationPolicy::getSubnetworkName() — Method in class IPAllocationPolicy
- A custom subnetwork name to be used if
create_subnetworkis true. If this field is empty, then an automatic name will be chosen for the new subnetwork. - IPAllocationPolicy::getClusterIpv4Cidr() — Method in class IPAllocationPolicy
- This field is deprecated, use cluster_ipv4_cidr_block.
- IPAllocationPolicy::getNodeIpv4Cidr() — Method in class IPAllocationPolicy
- This field is deprecated, use node_ipv4_cidr_block.
- IPAllocationPolicy::getServicesIpv4Cidr() — Method in class IPAllocationPolicy
- This field is deprecated, use services_ipv4_cidr_block.
- IPAllocationPolicy::getClusterSecondaryRangeName() — Method in class IPAllocationPolicy
- The name of the secondary range to be used for the cluster CIDR block. The secondary range will be used for pod IP addresses. This must be an existing secondary range associated with the cluster subnetwork.
- IPAllocationPolicy::getServicesSecondaryRangeName() — Method in class IPAllocationPolicy
- The name of the secondary range to be used as for the services CIDR block. The secondary range will be used for service ClusterIPs. This must be an existing secondary range associated with the cluster subnetwork.
- IPAllocationPolicy::getClusterIpv4CidrBlock() — Method in class IPAllocationPolicy
- The IP address range for the cluster pod IPs. If this field is set, then
cluster.cluster_ipv4_cidrmust be left blank. - IPAllocationPolicy::getNodeIpv4CidrBlock() — Method in class IPAllocationPolicy
- The IP address range of the instance IPs in this cluster.
- IPAllocationPolicy::getServicesIpv4CidrBlock() — Method in class IPAllocationPolicy
- The IP address range of the services IPs in this cluster. If blank, a range will be automatically chosen with the default size.
- KubernetesDashboard::getDisabled() — Method in class KubernetesDashboard
- Whether the Kubernetes Dashboard is enabled for this cluster.
- LegacyAbac::getEnabled() — Method in class LegacyAbac
- Whether the ABAC authorizer is enabled for this cluster. When enabled, identities in the system, including service accounts, nodes, and controllers, will have statically granted permissions beyond those provided by the RBAC configuration or IAM.
- ListClustersRequest::getProjectId() — Method in class ListClustersRequest
- The Google Developers Console project ID or project number.
- ListClustersRequest::getZone() — Method in class ListClustersRequest
- The name of the Google Compute Engine zone in which the cluster resides, or "-" for all zones.
- ListClustersResponse::getClusters() — Method in class ListClustersResponse
- A list of clusters in the project in the specified zone, or across all ones.
- ListClustersResponse::getMissingZones() — Method in class ListClustersResponse
- If any zones are listed here, the list of clusters returned may be missing those zones.
- ListNodePoolsRequest::getProjectId() — Method in class ListNodePoolsRequest
- The Google Developers Console project ID or project number.
- ListNodePoolsRequest::getZone() — Method in class ListNodePoolsRequest
- The name of the Google Compute Engine zone in which the cluster resides.
- ListNodePoolsRequest::getClusterId() — Method in class ListNodePoolsRequest
- The name of the cluster.
- ListNodePoolsResponse::getNodePools() — Method in class ListNodePoolsResponse
- A list of node pools for a cluster.
- ListOperationsRequest::getProjectId() — Method in class ListOperationsRequest
- The Google Developers Console project ID or project number.
- ListOperationsRequest::getZone() — Method in class ListOperationsRequest
- The name of the Google Compute Engine zone
to return operations for, or
-for all zones. - ListOperationsResponse::getOperations() — Method in class ListOperationsResponse
- A list of operations in the project in the specified zone.
- ListOperationsResponse::getMissingZones() — Method in class ListOperationsResponse
- If any zones are listed here, the list of operations returned may be missing the operations from those zones.
- MaintenancePolicy::getWindow() — Method in class MaintenancePolicy
- Specifies the maintenance window in which maintenance may be performed.
- MaintenanceWindow::getDailyMaintenanceWindow() — Method in class MaintenanceWindow
- DailyMaintenanceWindow specifies a daily maintenance operation window.
- MaintenanceWindow::getPolicy() — Method in class MaintenanceWindow
- MasterAuth::getUsername() — Method in class MasterAuth
- The username to use for HTTP basic authentication to the master endpoint.
- MasterAuth::getPassword() — Method in class MasterAuth
- The password to use for HTTP basic authentication to the master endpoint.
- MasterAuth::getClientCertificateConfig() — Method in class MasterAuth
- Configuration for client certificate authentication on the cluster. If no configuration is specified, a client certificate is issued.
- MasterAuth::getClusterCaCertificate() — Method in class MasterAuth
- [Output only] Base64-encoded public certificate that is the root of trust for the cluster.
- MasterAuth::getClientCertificate() — Method in class MasterAuth
- [Output only] Base64-encoded public certificate used by clients to authenticate to the cluster endpoint.
- MasterAuth::getClientKey() — Method in class MasterAuth
- [Output only] Base64-encoded private key used by clients to authenticate to the cluster endpoint.
- MasterAuthorizedNetworksConfig::getEnabled() — Method in class MasterAuthorizedNetworksConfig
- Whether or not master authorized networks is enabled.
- MasterAuthorizedNetworksConfig::getCidrBlocks() — Method in class MasterAuthorizedNetworksConfig
- cidr_blocks define up to 10 external networks that could access Kubernetes master through HTTPS.
- MasterAuthorizedNetworksConfig_CidrBlock::getDisplayName() — Method in class MasterAuthorizedNetworksConfig_CidrBlock
- display_name is an optional field for users to identify CIDR blocks.
- MasterAuthorizedNetworksConfig_CidrBlock::getCidrBlock() — Method in class MasterAuthorizedNetworksConfig_CidrBlock
- cidr_block must be specified in CIDR notation.
- NetworkPolicy::getProvider() — Method in class NetworkPolicy
- The selected network policy provider.
- NetworkPolicy::getEnabled() — Method in class NetworkPolicy
- Whether network policy is enabled on the cluster.
- NetworkPolicyConfig::getDisabled() — Method in class NetworkPolicyConfig
- Whether NetworkPolicy is enabled for this cluster.
- NodeConfig::getMachineType() — Method in class NodeConfig
- The name of a Google Compute Engine machine type (e.g.
- NodeConfig::getDiskSizeGb() — Method in class NodeConfig
- Size of the disk attached to each node, specified in GB.
- NodeConfig::getOauthScopes() — Method in class NodeConfig
- The set of Google API scopes to be made available on all of the node VMs under the "default" service account.
- NodeConfig::getServiceAccount() — Method in class NodeConfig
- The Google Cloud Platform Service Account to be used by the node VMs. If no Service Account is specified, the "default" service account is used.
- NodeConfig::getMetadata() — Method in class NodeConfig
- The metadata key/value pairs assigned to instances in the cluster.
- NodeConfig::getImageType() — Method in class NodeConfig
- The image type to use for this node. Note that for a given image type, the latest version of it will be used.
- NodeConfig::getLabels() — Method in class NodeConfig
- The map of Kubernetes labels (key/value pairs) to be applied to each node.
- NodeConfig::getLocalSsdCount() — Method in class NodeConfig
- The number of local SSD disks to be attached to the node.
- NodeConfig::getTags() — Method in class NodeConfig
- The list of instance tags applied to all nodes. Tags are used to identify valid sources or targets for network firewalls and are specified by the client during cluster or node pool creation. Each tag within the list must comply with RFC1035.
- NodeConfig::getPreemptible() — Method in class NodeConfig
- Whether the nodes are created as preemptible VM instances. See: https://cloud.google.com/compute/docs/instances/preemptible for more information about preemptible VM instances.
- NodeConfig::getAccelerators() — Method in class NodeConfig
- A list of hardware accelerators to be attached to each node.
- NodeConfig::getMinCpuPlatform() — Method in class NodeConfig
- Minimum CPU platform to be used by this instance. The instance may be
scheduled on the specified or newer CPU platform. Applicable values are the
friendly names of CPU platforms, such as
minCpuPlatform: "Intel Haswell"orminCpuPlatform: "Intel Sandy Bridge". For more information, read how to specify min CPU platform - NodeManagement::getAutoUpgrade() — Method in class NodeManagement
- A flag that specifies whether node auto-upgrade is enabled for the node pool. If enabled, node auto-upgrade helps keep the nodes in your node pool up to date with the latest release version of Kubernetes.
- NodeManagement::getAutoRepair() — Method in class NodeManagement
- A flag that specifies whether the node auto-repair is enabled for the node pool. If enabled, the nodes in this node pool will be monitored and, if they fail health checks too many times, an automatic repair action will be triggered.
- NodeManagement::getUpgradeOptions() — Method in class NodeManagement
- Specifies the Auto Upgrade knobs for the node pool.
- NodePool::getName() — Method in class NodePool
- The name of the node pool.
- NodePool::getConfig() — Method in class NodePool
- The node configuration of the pool.
- NodePool::getInitialNodeCount() — Method in class NodePool
- The initial node count for the pool. You must ensure that your Compute Engine resource quota is sufficient for this number of instances. You must also have available firewall and routes quota.
- NodePool::getSelfLink() — Method in class NodePool
- [Output only] Server-defined URL for the resource.
- NodePool::getVersion() — Method in class NodePool
- The version of the Kubernetes of this node.
- NodePool::getInstanceGroupUrls() — Method in class NodePool
- [Output only] The resource URLs of the managed instance groups associated with this node pool.
- NodePool::getStatus() — Method in class NodePool
- [Output only] The status of the nodes in this pool instance.
- NodePool::getStatusMessage() — Method in class NodePool
- [Output only] Additional information about the current status of this node pool instance, if available.
- NodePool::getAutoscaling() — Method in class NodePool
- Autoscaler configuration for this NodePool. Autoscaler is enabled only if a valid configuration is present.
- NodePool::getManagement() — Method in class NodePool
- NodeManagement configuration for this NodePool.
- NodePoolAutoscaling::getEnabled() — Method in class NodePoolAutoscaling
- Is autoscaling enabled for this node pool.
- NodePoolAutoscaling::getMinNodeCount() — Method in class NodePoolAutoscaling
- Minimum number of nodes in the NodePool. Must be >= 1 and <= max_node_count.
- NodePoolAutoscaling::getMaxNodeCount() — Method in class NodePoolAutoscaling
- Maximum number of nodes in the NodePool. Must be >= min_node_count. There has to enough quota to scale up the cluster.
- Operation::getName() — Method in class Operation
- The server-assigned ID for the operation.
- Operation::getZone() — Method in class Operation
- The name of the Google Compute Engine zone in which the operation is taking place.
- Operation::getOperationType() — Method in class Operation
- The operation type.
- Operation::getStatus() — Method in class Operation
- The current status of the operation.
- Operation::getDetail() — Method in class Operation
- Detailed operation progress, if available.
- Operation::getStatusMessage() — Method in class Operation
- If an error has occurred, a textual description of the error.
- Operation::getSelfLink() — Method in class Operation
- Server-defined URL for the resource.
- Operation::getTargetLink() — Method in class Operation
- Server-defined URL for the target of the operation.
- Operation::getStartTime() — Method in class Operation
- [Output only] The time the operation started, in RFC3339 text format.
- Operation::getEndTime() — Method in class Operation
- [Output only] The time the operation completed, in RFC3339 text format.
- RollbackNodePoolUpgradeRequest::getProjectId() — Method in class RollbackNodePoolUpgradeRequest
- The Google Developers Console project ID or project number.
- RollbackNodePoolUpgradeRequest::getZone() — Method in class RollbackNodePoolUpgradeRequest
- The name of the Google Compute Engine zone in which the cluster resides.
- RollbackNodePoolUpgradeRequest::getClusterId() — Method in class RollbackNodePoolUpgradeRequest
- The name of the cluster to rollback.
- RollbackNodePoolUpgradeRequest::getNodePoolId() — Method in class RollbackNodePoolUpgradeRequest
- The name of the node pool to rollback.
- ServerConfig::getDefaultClusterVersion() — Method in class ServerConfig
- Version of Kubernetes the service deploys by default.
- ServerConfig::getValidNodeVersions() — Method in class ServerConfig
- List of valid node upgrade target versions.
- ServerConfig::getDefaultImageType() — Method in class ServerConfig
- Default image type.
- ServerConfig::getValidImageTypes() — Method in class ServerConfig
- List of valid image types.
- ServerConfig::getValidMasterVersions() — Method in class ServerConfig
- List of valid master versions.
- SetAddonsConfigRequest::getProjectId() — Method in class SetAddonsConfigRequest
- The Google Developers Console project ID or project number.
- SetAddonsConfigRequest::getZone() — Method in class SetAddonsConfigRequest
- The name of the Google Compute Engine zone in which the cluster resides.
- SetAddonsConfigRequest::getClusterId() — Method in class SetAddonsConfigRequest
- The name of the cluster to upgrade.
- SetAddonsConfigRequest::getAddonsConfig() — Method in class SetAddonsConfigRequest
- The desired configurations for the various addons available to run in the cluster.
- SetLabelsRequest::getProjectId() — Method in class SetLabelsRequest
- The Google Developers Console project ID or project number.
- SetLabelsRequest::getZone() — Method in class SetLabelsRequest
- The name of the Google Compute Engine zone in which the cluster resides.
- SetLabelsRequest::getClusterId() — Method in class SetLabelsRequest
- The name of the cluster.
- SetLabelsRequest::getResourceLabels() — Method in class SetLabelsRequest
- The labels to set for that cluster.
- SetLabelsRequest::getLabelFingerprint() — Method in class SetLabelsRequest
- The fingerprint of the previous set of labels for this resource,
used to detect conflicts. The fingerprint is initially generated by
Container Engine and changes after every request to modify or update
labels. You must always provide an up-to-date fingerprint hash when
updating or changing labels. Make a
get()request to the resource to get the latest fingerprint. - SetLegacyAbacRequest::getProjectId() — Method in class SetLegacyAbacRequest
- The Google Developers Console project ID or project number.
- SetLegacyAbacRequest::getZone() — Method in class SetLegacyAbacRequest
- The name of the Google Compute Engine zone in which the cluster resides.
- SetLegacyAbacRequest::getClusterId() — Method in class SetLegacyAbacRequest
- The name of the cluster to update.
- SetLegacyAbacRequest::getEnabled() — Method in class SetLegacyAbacRequest
- Whether ABAC authorization will be enabled in the cluster.
- SetLocationsRequest::getProjectId() — Method in class SetLocationsRequest
- The Google Developers Console project ID or project number.
- SetLocationsRequest::getZone() — Method in class SetLocationsRequest
- The name of the Google Compute Engine zone in which the cluster resides.
- SetLocationsRequest::getClusterId() — Method in class SetLocationsRequest
- The name of the cluster to upgrade.
- SetLocationsRequest::getLocations() — Method in class SetLocationsRequest
- The desired list of Google Compute Engine locations in which the cluster's nodes should be located. Changing the locations a cluster is in will result in nodes being either created or removed from the cluster, depending on whether locations are being added or removed.
- SetLoggingServiceRequest::getProjectId() — Method in class SetLoggingServiceRequest
- The Google Developers Console project ID or project number.
- SetLoggingServiceRequest::getZone() — Method in class SetLoggingServiceRequest
- The name of the Google Compute Engine zone in which the cluster resides.
- SetLoggingServiceRequest::getClusterId() — Method in class SetLoggingServiceRequest
- The name of the cluster to upgrade.
- SetLoggingServiceRequest::getLoggingService() — Method in class SetLoggingServiceRequest
- The logging service the cluster should use to write metrics.
- SetMaintenancePolicyRequest::getProjectId() — Method in class SetMaintenancePolicyRequest
- The Google Developers Console project ID or project number.
- SetMaintenancePolicyRequest::getZone() — Method in class SetMaintenancePolicyRequest
- The name of the Google Compute Engine zone in which the cluster resides.
- SetMaintenancePolicyRequest::getClusterId() — Method in class SetMaintenancePolicyRequest
- The name of the cluster to update.
- SetMaintenancePolicyRequest::getMaintenancePolicy() — Method in class SetMaintenancePolicyRequest
- The maintenance policy to be set for the cluster. An empty field clears the existing maintenance policy.
- SetMasterAuthRequest::getProjectId() — Method in class SetMasterAuthRequest
- The Google Developers Console project ID or project number.
- SetMasterAuthRequest::getZone() — Method in class SetMasterAuthRequest
- The name of the Google Compute Engine zone in which the cluster resides.
- SetMasterAuthRequest::getClusterId() — Method in class SetMasterAuthRequest
- The name of the cluster to upgrade.
- SetMasterAuthRequest::getAction() — Method in class SetMasterAuthRequest
- The exact form of action to be taken on the master auth.
- SetMasterAuthRequest::getUpdate() — Method in class SetMasterAuthRequest
- A description of the update.
- SetMonitoringServiceRequest::getProjectId() — Method in class SetMonitoringServiceRequest
- The Google Developers Console project ID or project number.
- SetMonitoringServiceRequest::getZone() — Method in class SetMonitoringServiceRequest
- The name of the Google Compute Engine zone in which the cluster resides.
- SetMonitoringServiceRequest::getClusterId() — Method in class SetMonitoringServiceRequest
- The name of the cluster to upgrade.
- SetMonitoringServiceRequest::getMonitoringService() — Method in class SetMonitoringServiceRequest
- The monitoring service the cluster should use to write metrics.
- SetNetworkPolicyRequest::getProjectId() — Method in class SetNetworkPolicyRequest
- The Google Developers Console project ID or project number.
- SetNetworkPolicyRequest::getZone() — Method in class SetNetworkPolicyRequest
- The name of the Google Compute Engine zone in which the cluster resides.
- SetNetworkPolicyRequest::getClusterId() — Method in class SetNetworkPolicyRequest
- The name of the cluster.
- SetNetworkPolicyRequest::getNetworkPolicy() — Method in class SetNetworkPolicyRequest
- Configuration options for the NetworkPolicy feature.
- SetNodePoolAutoscalingRequest::getProjectId() — Method in class SetNodePoolAutoscalingRequest
- The Google Developers Console project ID or project number.
- SetNodePoolAutoscalingRequest::getZone() — Method in class SetNodePoolAutoscalingRequest
- The name of the Google Compute Engine zone in which the cluster resides.
- SetNodePoolAutoscalingRequest::getClusterId() — Method in class SetNodePoolAutoscalingRequest
- The name of the cluster to upgrade.
- SetNodePoolAutoscalingRequest::getNodePoolId() — Method in class SetNodePoolAutoscalingRequest
- The name of the node pool to upgrade.
- SetNodePoolAutoscalingRequest::getAutoscaling() — Method in class SetNodePoolAutoscalingRequest
- Autoscaling configuration for the node pool.
- SetNodePoolManagementRequest::getProjectId() — Method in class SetNodePoolManagementRequest
- The Google Developers Console project ID or project number.
- SetNodePoolManagementRequest::getZone() — Method in class SetNodePoolManagementRequest
- The name of the Google Compute Engine zone in which the cluster resides.
- SetNodePoolManagementRequest::getClusterId() — Method in class SetNodePoolManagementRequest
- The name of the cluster to update.
- SetNodePoolManagementRequest::getNodePoolId() — Method in class SetNodePoolManagementRequest
- The name of the node pool to update.
- SetNodePoolManagementRequest::getManagement() — Method in class SetNodePoolManagementRequest
- NodeManagement configuration for the node pool.
- SetNodePoolSizeRequest::getProjectId() — Method in class SetNodePoolSizeRequest
- The Google Developers Console project ID or project number.
- SetNodePoolSizeRequest::getZone() — Method in class SetNodePoolSizeRequest
- The name of the Google Compute Engine zone in which the cluster resides.
- SetNodePoolSizeRequest::getClusterId() — Method in class SetNodePoolSizeRequest
- The name of the cluster to update.
- SetNodePoolSizeRequest::getNodePoolId() — Method in class SetNodePoolSizeRequest
- The name of the node pool to update.
- SetNodePoolSizeRequest::getNodeCount() — Method in class SetNodePoolSizeRequest
- The desired node count for the pool.
- StartIPRotationRequest::getProjectId() — Method in class StartIPRotationRequest
- The Google Developers Console project ID or project number.
- StartIPRotationRequest::getZone() — Method in class StartIPRotationRequest
- The name of the Google Compute Engine zone in which the cluster resides.
- StartIPRotationRequest::getClusterId() — Method in class StartIPRotationRequest
- The name of the cluster.
- UpdateClusterRequest::getProjectId() — Method in class UpdateClusterRequest
- The Google Developers Console project ID or project number.
- UpdateClusterRequest::getZone() — Method in class UpdateClusterRequest
- The name of the Google Compute Engine zone in which the cluster resides.
- UpdateClusterRequest::getClusterId() — Method in class UpdateClusterRequest
- The name of the cluster to upgrade.
- UpdateClusterRequest::getUpdate() — Method in class UpdateClusterRequest
- A description of the update.
- UpdateMasterRequest::getProjectId() — Method in class UpdateMasterRequest
- The Google Developers Console project ID or project number.
- UpdateMasterRequest::getZone() — Method in class UpdateMasterRequest
- The name of the Google Compute Engine zone in which the cluster resides.
- UpdateMasterRequest::getClusterId() — Method in class UpdateMasterRequest
- The name of the cluster to upgrade.
- UpdateMasterRequest::getMasterVersion() — Method in class UpdateMasterRequest
- The Kubernetes version to change the master to. The only valid value is the latest supported version. Use "-" to have the server automatically select the latest version.
- UpdateNodePoolRequest::getProjectId() — Method in class UpdateNodePoolRequest
- The Google Developers Console project ID or project number.
- UpdateNodePoolRequest::getZone() — Method in class UpdateNodePoolRequest
- The name of the Google Compute Engine zone in which the cluster resides.
- UpdateNodePoolRequest::getClusterId() — Method in class UpdateNodePoolRequest
- The name of the cluster to upgrade.
- UpdateNodePoolRequest::getNodePoolId() — Method in class UpdateNodePoolRequest
- The name of the node pool to upgrade.
- UpdateNodePoolRequest::getNodeVersion() — Method in class UpdateNodePoolRequest
- The Kubernetes version to change the nodes to (typically an
upgrade). Use
-to upgrade to the latest version supported by the server. - UpdateNodePoolRequest::getImageType() — Method in class UpdateNodePoolRequest
- The desired image type for the node pool.
- AcceleratorConfig::getAcceleratorTypeUri() — Method in class AcceleratorConfig
- Full URL, partial URI, or short name of the accelerator type resource to
expose to this instance. See Google Compute Engine AcceleratorTypes
Examples
*
https://www.googleapis.com/compute/beta/projects/[project_id]/zones/us-east1-a/acceleratorTypes/nvidia-tesla-k80*projects/[project_id]/zones/us-east1-a/acceleratorTypes/nvidia-tesla-k80*nvidia-tesla-k80 - AcceleratorConfig::getAcceleratorCount() — Method in class AcceleratorConfig
- The number of the accelerator cards of this type exposed to this instance.
- CancelJobRequest::getProjectId() — Method in class CancelJobRequest
- Required. The ID of the Google Cloud Platform project that the job belongs to.
- CancelJobRequest::getRegion() — Method in class CancelJobRequest
- Required. The Cloud Dataproc region in which to handle the request.
- CancelJobRequest::getJobId() — Method in class CancelJobRequest
- Required. The job ID.
- Cluster::getProjectId() — Method in class Cluster
- Required. The Google Cloud Platform project ID that the cluster belongs to.
- Cluster::getClusterName() — Method in class Cluster
- Required. The cluster name. Cluster names within a project must be unique. Names of deleted clusters can be reused.
- Cluster::getConfig() — Method in class Cluster
- Required. The cluster config. Note that Cloud Dataproc may set default values, and values may change when clusters are updated.
- Cluster::getLabels() — Method in class Cluster
- Optional. The labels to associate with this cluster.
- Cluster::getStatus() — Method in class Cluster
- Output-only. Cluster status.
- Cluster::getStatusHistory() — Method in class Cluster
- Output-only. The previous cluster status.
- Cluster::getClusterUuid() — Method in class Cluster
- Output-only. A cluster UUID (Unique Universal Identifier). Cloud Dataproc generates this value when it creates the cluster.
- Cluster::getMetrics() — Method in class Cluster
- Contains cluster daemon metrics such as HDFS and YARN stats.
- ClusterConfig::getConfigBucket() — Method in class ClusterConfig
- Optional. A Google Cloud Storage staging bucket used for sharing generated SSH keys and config. If you do not specify a staging bucket, Cloud Dataproc will determine an appropriate Cloud Storage location (US, ASIA, or EU) for your cluster's staging bucket according to the Google Compute Engine zone where your cluster is deployed, and then it will create and manage this project-level, per-location bucket for you.
- ClusterConfig::getGceClusterConfig() — Method in class ClusterConfig
- Required. The shared Google Compute Engine config settings for all instances in a cluster.
- ClusterConfig::getMasterConfig() — Method in class ClusterConfig
- Optional. The Google Compute Engine config settings for the master instance in a cluster.
- ClusterConfig::getWorkerConfig() — Method in class ClusterConfig
- Optional. The Google Compute Engine config settings for worker instances in a cluster.
- ClusterConfig::getSecondaryWorkerConfig() — Method in class ClusterConfig
- Optional. The Google Compute Engine config settings for additional worker instances in a cluster.
- ClusterConfig::getSoftwareConfig() — Method in class ClusterConfig
- Optional. The config settings for software inside the cluster.
- ClusterConfig::getInitializationActions() — Method in class ClusterConfig
- Optional. Commands to execute on each node after config is completed. By default, executables are run on master and all worker nodes.
- ClusterControllerGrpcClient::GetCluster() — Method in class ClusterControllerGrpcClient
- Gets the resource representation for a cluster in a project.
- ClusterMetrics::getHdfsMetrics() — Method in class ClusterMetrics
- The HDFS metrics.
- ClusterMetrics::getYarnMetrics() — Method in class ClusterMetrics
- The YARN metrics.
- ClusterOperationMetadata::getClusterName() — Method in class ClusterOperationMetadata
- Output-only. Name of the cluster for the operation.
- ClusterOperationMetadata::getClusterUuid() — Method in class ClusterOperationMetadata
- Output-only. Cluster UUID for the operation.
- ClusterOperationMetadata::getStatus() — Method in class ClusterOperationMetadata
- Output-only. Current operation status.
- ClusterOperationMetadata::getStatusHistory() — Method in class ClusterOperationMetadata
- Output-only. The previous operation status.
- ClusterOperationMetadata::getOperationType() — Method in class ClusterOperationMetadata
- Output-only. The operation type.
- ClusterOperationMetadata::getDescription() — Method in class ClusterOperationMetadata
- Output-only. Short description of operation.
- ClusterOperationMetadata::getLabels() — Method in class ClusterOperationMetadata
- Output-only. Labels associated with the operation
- ClusterOperationMetadata::getWarnings() — Method in class ClusterOperationMetadata
- Output-only. Errors encountered during operation execution.
- ClusterOperationStatus::getState() — Method in class ClusterOperationStatus
- Output-only. A message containing the operation state.
- ClusterOperationStatus::getInnerState() — Method in class ClusterOperationStatus
- Output-only. A message containing the detailed operation state.
- ClusterOperationStatus::getDetails() — Method in class ClusterOperationStatus
- Output-only.A message containing any operation metadata details.
- ClusterOperationStatus::getStateStartTime() — Method in class ClusterOperationStatus
- Output-only. The time this state was entered.
- ClusterStatus::getState() — Method in class ClusterStatus
- Output-only. The cluster's state.
- ClusterStatus::getDetail() — Method in class ClusterStatus
- Output-only. Optional details of cluster's state.
- ClusterStatus::getStateStartTime() — Method in class ClusterStatus
- Output-only. Time when this state was entered.
- ClusterStatus::getSubstate() — Method in class ClusterStatus
- Output-only. Additional state information that includes status reported by the agent.
- CreateClusterRequest::getProjectId() — Method in class CreateClusterRequest
- Required. The ID of the Google Cloud Platform project that the cluster belongs to.
- CreateClusterRequest::getRegion() — Method in class CreateClusterRequest
- Required. The Cloud Dataproc region in which to handle the request.
- CreateClusterRequest::getCluster() — Method in class CreateClusterRequest
- Required. The cluster to create.
- DeleteClusterRequest::getProjectId() — Method in class DeleteClusterRequest
- Required. The ID of the Google Cloud Platform project that the cluster belongs to.
- DeleteClusterRequest::getRegion() — Method in class DeleteClusterRequest
- Required. The Cloud Dataproc region in which to handle the request.
- DeleteClusterRequest::getClusterName() — Method in class DeleteClusterRequest
- Required. The cluster name.
- DeleteJobRequest::getProjectId() — Method in class DeleteJobRequest
- Required. The ID of the Google Cloud Platform project that the job belongs to.
- DeleteJobRequest::getRegion() — Method in class DeleteJobRequest
- Required. The Cloud Dataproc region in which to handle the request.
- DeleteJobRequest::getJobId() — Method in class DeleteJobRequest
- Required. The job ID.
- DiagnoseClusterRequest::getProjectId() — Method in class DiagnoseClusterRequest
- Required. The ID of the Google Cloud Platform project that the cluster belongs to.
- DiagnoseClusterRequest::getRegion() — Method in class DiagnoseClusterRequest
- Required. The Cloud Dataproc region in which to handle the request.
- DiagnoseClusterRequest::getClusterName() — Method in class DiagnoseClusterRequest
- Required. The cluster name.
- DiagnoseClusterResults::getOutputUri() — Method in class DiagnoseClusterResults
- Output-only. The Google Cloud Storage URI of the diagnostic output.
- DiskConfig::getBootDiskSizeGb() — Method in class DiskConfig
- Optional. Size in GB of the boot disk (default is 500GB).
- DiskConfig::getNumLocalSsds() — Method in class DiskConfig
- Optional. Number of attached SSDs, from 0 to 4 (default is 0).
- GceClusterConfig — Class in namespace Google\Cloud\Dataproc\V1
- Common config settings for resources of Google Compute Engine cluster instances, applicable to all instances in the cluster.
- GceClusterConfig::getZoneUri() — Method in class GceClusterConfig
- Optional. The zone where the Google Compute Engine cluster will be located.
- GceClusterConfig::getNetworkUri() — Method in class GceClusterConfig
- Optional. The Google Compute Engine network to be used for machine
communications. Cannot be specified with subnetwork_uri. If neither
network_urinorsubnetwork_uriis specified, the "default" network of the project is used, if it exists. Cannot be a "Custom Subnet Network" (see Using Subnetworks for more information). - GceClusterConfig::getSubnetworkUri() — Method in class GceClusterConfig
- Optional. The Google Compute Engine subnetwork to be used for machine communications. Cannot be specified with network_uri.
- GceClusterConfig::getInternalIpOnly() — Method in class GceClusterConfig
- Optional. If true, all instances in the cluster will only have internal IP addresses. By default, clusters are not restricted to internal IP addresses, and will have ephemeral external IP addresses assigned to each instance.
- GceClusterConfig::getServiceAccount() — Method in class GceClusterConfig
- Optional. The service account of the instances. Defaults to the default Google Compute Engine service account. Custom service accounts need permissions equivalent to the folloing IAM roles: * roles/logging.logWriter * roles/storage.objectAdmin (see https://cloud.google.com/compute/docs/access/service-accounts#custom_service_accounts for more information).
- GceClusterConfig::getServiceAccountScopes() — Method in class GceClusterConfig
- Optional. The URIs of service account scopes to be included in Google Compute Engine instances. The following base set of scopes is always included: * https://www.googleapis.com/auth/cloud.useraccounts.readonly * https://www.googleapis.com/auth/devstorage.read_write * https://www.googleapis.com/auth/logging.write If no scopes are specified, the following defaults are also provided: * https://www.googleapis.com/auth/bigquery * https://www.googleapis.com/auth/bigtable.admin.table * https://www.googleapis.com/auth/bigtable.data * https://www.googleapis.com/auth/devstorage.full_control
- GceClusterConfig::getTags() — Method in class GceClusterConfig
- The Google Compute Engine tags to add to all instances (see Tagging instances).
- GceClusterConfig::getMetadata() — Method in class GceClusterConfig
- The Google Compute Engine metadata entries to add to all instances (see Project and instance metadata).
- GetClusterRequest — Class in namespace Google\Cloud\Dataproc\V1
- Request to get the resource representation for a cluster in a project.
- GetClusterRequest::getProjectId() — Method in class GetClusterRequest
- Required. The ID of the Google Cloud Platform project that the cluster belongs to.
- GetClusterRequest::getRegion() — Method in class GetClusterRequest
- Required. The Cloud Dataproc region in which to handle the request.
- GetClusterRequest::getClusterName() — Method in class GetClusterRequest
- Required. The cluster name.
- GetJobRequest — Class in namespace Google\Cloud\Dataproc\V1
- A request to get the resource representation for a job in a project.
- GetJobRequest::getProjectId() — Method in class GetJobRequest
- Required. The ID of the Google Cloud Platform project that the job belongs to.
- GetJobRequest::getRegion() — Method in class GetJobRequest
- Required. The Cloud Dataproc region in which to handle the request.
- GetJobRequest::getJobId() — Method in class GetJobRequest
- Required. The job ID.
- HadoopJob::getMainJarFileUri() — Method in class HadoopJob
- The HCFS URI of the jar file containing the main class.
- HadoopJob::getMainClass() — Method in class HadoopJob
- The name of the driver's main class. The jar file containing the class
must be in the default CLASSPATH or specified in
jar_file_uris. - HadoopJob::getArgs() — Method in class HadoopJob
- Optional. The arguments to pass to the driver. Do not
include arguments, such as
-libjarsor-Dfoo=bar, that can be set as job properties, since a collision may occur that causes an incorrect job submission. - HadoopJob::getJarFileUris() — Method in class HadoopJob
- Optional. Jar file URIs to add to the CLASSPATHs of the Hadoop driver and tasks.
- HadoopJob::getFileUris() — Method in class HadoopJob
- Optional. HCFS (Hadoop Compatible Filesystem) URIs of files to be copied to the working directory of Hadoop drivers and distributed tasks. Useful for naively parallel tasks.
- HadoopJob::getArchiveUris() — Method in class HadoopJob
- Optional. HCFS URIs of archives to be extracted in the working directory of Hadoop drivers and tasks. Supported file types:
- HadoopJob::getProperties() — Method in class HadoopJob
- Optional. A mapping of property names to values, used to configure Hadoop.
- HadoopJob::getLoggingConfig() — Method in class HadoopJob
- Optional. The runtime log config for job execution.
- HadoopJob::getDriver() — Method in class HadoopJob
- HiveJob::getQueryFileUri() — Method in class HiveJob
- The HCFS URI of the script that contains Hive queries.
- HiveJob::getQueryList() — Method in class HiveJob
- A list of queries.
- HiveJob::getContinueOnFailure() — Method in class HiveJob
- Optional. Whether to continue executing queries if a query fails.
- HiveJob::getScriptVariables() — Method in class HiveJob
- Optional. Mapping of query variable names to values (equivalent to the
Hive command:
SET name="value";). - HiveJob::getProperties() — Method in class HiveJob
- Optional. A mapping of property names and values, used to configure Hive.
- HiveJob::getJarFileUris() — Method in class HiveJob
- Optional. HCFS URIs of jar files to add to the CLASSPATH of the Hive server and Hadoop MapReduce (MR) tasks. Can contain Hive SerDes and UDFs.
- HiveJob::getQueries() — Method in class HiveJob
- InstanceGroupConfig::getNumInstances() — Method in class InstanceGroupConfig
- Optional. The number of VM instances in the instance group.
- InstanceGroupConfig::getInstanceNames() — Method in class InstanceGroupConfig
- Optional. The list of instance names. Cloud Dataproc derives the names from
cluster_name,num_instances, and the instance group if not set by user (recommended practice is to let Cloud Dataproc derive the name). - InstanceGroupConfig::getImageUri() — Method in class InstanceGroupConfig
- Output-only. The Google Compute Engine image resource used for cluster
instances. Inferred from
SoftwareConfig.image_version. - InstanceGroupConfig::getMachineTypeUri() — Method in class InstanceGroupConfig
- Optional. The Google Compute Engine machine type used for cluster instances.
- InstanceGroupConfig::getDiskConfig() — Method in class InstanceGroupConfig
- Optional. Disk option config settings.
- InstanceGroupConfig::getIsPreemptible() — Method in class InstanceGroupConfig
- Optional. Specifies that this instance group contains preemptible instances.
- InstanceGroupConfig::getManagedGroupConfig() — Method in class InstanceGroupConfig
- Output-only. The config for Google Compute Engine Instance Group Manager that manages this group.
- InstanceGroupConfig::getAccelerators() — Method in class InstanceGroupConfig
- Optional. The Google Compute Engine accelerator configuration for these instances.
- Job::getReference() — Method in class Job
- Optional. The fully qualified reference to the job, which can be used to
obtain the equivalent REST path of the job resource. If this property
is not specified when a job is created, the server generates a
job_id. - Job::getPlacement() — Method in class Job
- Required. Job information, including how, when, and where to run the job.
- Job::getHadoopJob() — Method in class Job
- Job is a Hadoop job.
- Job::getSparkJob() — Method in class Job
- Job is a Spark job.
- Job::getPysparkJob() — Method in class Job
- Job is a Pyspark job.
- Job::getHiveJob() — Method in class Job
- Job is a Hive job.
- Job::getPigJob() — Method in class Job
- Job is a Pig job.
- Job::getSparkSqlJob() — Method in class Job
- Job is a SparkSql job.
- Job::getStatus() — Method in class Job
- Output-only. The job status. Additional application-specific
status information may be contained in the
type_jobandyarn_applicationsfields. - Job::getStatusHistory() — Method in class Job
- Output-only. The previous job status.
- Job::getYarnApplications() — Method in class Job
- Output-only. The collection of YARN applications spun up by this job.
- Job::getDriverOutputResourceUri() — Method in class Job
- Output-only. A URI pointing to the location of the stdout of the job's driver program.
- Job::getDriverControlFilesUri() — Method in class Job
- Output-only. If present, the location of miscellaneous control files
which may be used as part of job setup and handling. If not present,
control files may be placed in the same location as
driver_output_uri. - Job::getLabels() — Method in class Job
- Optional. The labels to associate with this job.
- Job::getScheduling() — Method in class Job
- Optional. Job scheduling configuration.
- Job::getTypeJob() — Method in class Job
- JobControllerGrpcClient::GetJob() — Method in class JobControllerGrpcClient
- Gets the resource representation for a job in a project.
- JobPlacement::getClusterName() — Method in class JobPlacement
- Required. The name of the cluster where the job will be submitted.
- JobPlacement::getClusterUuid() — Method in class JobPlacement
- Output-only. A cluster UUID generated by the Cloud Dataproc service when the job is submitted.
- JobReference::getProjectId() — Method in class JobReference
- Required. The ID of the Google Cloud Platform project that the job belongs to.
- JobReference::getJobId() — Method in class JobReference
- Optional. The job ID, which must be unique within the project. The job ID is generated by the server upon job submission or provided by the user as a means to perform retries without creating duplicate jobs. The ID must contain only letters (a-z, A-Z), numbers (0-9), underscores (_), or hyphens (-). The maximum length is 100 characters.
- JobScheduling::getMaxFailuresPerHour() — Method in class JobScheduling
- Optional. Maximum number of times per hour a driver may be restarted as a result of driver terminating with non-zero code before job is reported failed.
- JobStatus::getState() — Method in class JobStatus
- Output-only. A state message specifying the overall job state.
- JobStatus::getDetails() — Method in class JobStatus
- Output-only. Optional job state details, such as an error
description if the state is
ERROR. - JobStatus::getStateStartTime() — Method in class JobStatus
- Output-only. The time when this state was entered.
- JobStatus::getSubstate() — Method in class JobStatus
- Output-only. Additional state information, which includes status reported by the agent.
- ListClustersRequest::getProjectId() — Method in class ListClustersRequest
- Required. The ID of the Google Cloud Platform project that the cluster belongs to.
- ListClustersRequest::getRegion() — Method in class ListClustersRequest
- Required. The Cloud Dataproc region in which to handle the request.
- ListClustersRequest::getFilter() — Method in class ListClustersRequest
- Optional. A filter constraining the clusters to list. Filters are case-sensitive and have the following syntax: field = value [AND [field = value]] .
- ListClustersRequest::getPageSize() — Method in class ListClustersRequest
- Optional. The standard List page size.
- ListClustersRequest::getPageToken() — Method in class ListClustersRequest
- Optional. The standard List page token.
- ListClustersResponse::getClusters() — Method in class ListClustersResponse
- Output-only. The clusters in the project.
- ListClustersResponse::getNextPageToken() — Method in class ListClustersResponse
- Output-only. This token is included in the response if there are more
results to fetch. To fetch additional results, provide this value as the
page_tokenin a subsequentListClustersRequest. - ListJobsRequest::getProjectId() — Method in class ListJobsRequest
- Required. The ID of the Google Cloud Platform project that the job belongs to.
- ListJobsRequest::getRegion() — Method in class ListJobsRequest
- Required. The Cloud Dataproc region in which to handle the request.
- ListJobsRequest::getPageSize() — Method in class ListJobsRequest
- Optional. The number of results to return in each response.
- ListJobsRequest::getPageToken() — Method in class ListJobsRequest
- Optional. The page token, returned by a previous call, to request the next page of results.
- ListJobsRequest::getClusterName() — Method in class ListJobsRequest
- Optional. If set, the returned jobs list includes only jobs that were submitted to the named cluster.
- ListJobsRequest::getJobStateMatcher() — Method in class ListJobsRequest
- Optional. Specifies enumerated categories of jobs to list.
- ListJobsRequest::getFilter() — Method in class ListJobsRequest
- Optional. A filter constraining the jobs to list. Filters are case-sensitive and have the following syntax: [field = value] AND [field [= value]] .
- ListJobsResponse::getJobs() — Method in class ListJobsResponse
- Output-only. Jobs list.
- ListJobsResponse::getNextPageToken() — Method in class ListJobsResponse
- Optional. This token is included in the response if there are more results
to fetch. To fetch additional results, provide this value as the
page_tokenin a subsequentListJobsRequest. - LoggingConfig::getDriverLogLevels() — Method in class LoggingConfig
- The per-package log levels for the driver. This may include "root" package name to configure rootLogger.
- ManagedGroupConfig::getInstanceTemplateName() — Method in class ManagedGroupConfig
- Output-only. The name of the Instance Template used for the Managed Instance Group.
- ManagedGroupConfig::getInstanceGroupManagerName() — Method in class ManagedGroupConfig
- Output-only. The name of the Instance Group Manager for this group.
- NodeInitializationAction::getExecutableFile() — Method in class NodeInitializationAction
- Required. Google Cloud Storage URI of executable file.
- NodeInitializationAction::getExecutionTimeout() — Method in class NodeInitializationAction
- Optional. Amount of time executable has to complete. Default is 10 minutes. Cluster creation fails with an explanatory error message (the name of the executable that caused the error and the exceeded timeout period) if the executable is not completed at end of the timeout period.
- PigJob::getQueryFileUri() — Method in class PigJob
- The HCFS URI of the script that contains the Pig queries.
- PigJob::getQueryList() — Method in class PigJob
- A list of queries.
- PigJob::getContinueOnFailure() — Method in class PigJob
- Optional. Whether to continue executing queries if a query fails.
- PigJob::getScriptVariables() — Method in class PigJob
- Optional. Mapping of query variable names to values (equivalent to the Pig
command:
name=[value]). - PigJob::getProperties() — Method in class PigJob
- Optional. A mapping of property names to values, used to configure Pig.
- PigJob::getJarFileUris() — Method in class PigJob
- Optional. HCFS URIs of jar files to add to the CLASSPATH of the Pig Client and Hadoop MapReduce (MR) tasks. Can contain Pig UDFs.
- PigJob::getLoggingConfig() — Method in class PigJob
- Optional. The runtime log config for job execution.
- PigJob::getQueries() — Method in class PigJob
- PySparkJob::getMainPythonFileUri() — Method in class PySparkJob
- Required. The HCFS URI of the main Python file to use as the driver. Must be a .py file.
- PySparkJob::getArgs() — Method in class PySparkJob
- Optional. The arguments to pass to the driver. Do not include arguments,
such as
--conf, that can be set as job properties, since a collision may occur that causes an incorrect job submission. - PySparkJob::getPythonFileUris() — Method in class PySparkJob
- Optional. HCFS file URIs of Python files to pass to the PySpark framework. Supported file types: .py, .egg, and .zip.
- PySparkJob::getJarFileUris() — Method in class PySparkJob
- Optional. HCFS URIs of jar files to add to the CLASSPATHs of the Python driver and tasks.
- PySparkJob::getFileUris() — Method in class PySparkJob
- Optional. HCFS URIs of files to be copied to the working directory of Python drivers and distributed tasks. Useful for naively parallel tasks.
- PySparkJob::getArchiveUris() — Method in class PySparkJob
- Optional. HCFS URIs of archives to be extracted in the working directory of
- PySparkJob::getProperties() — Method in class PySparkJob
- Optional. A mapping of property names to values, used to configure PySpark.
- PySparkJob::getLoggingConfig() — Method in class PySparkJob
- Optional. The runtime log config for job execution.
- QueryList::getQueries() — Method in class QueryList
- Required. The queries to execute. You do not need to terminate a query with a semicolon. Multiple queries can be specified in one string by separating each with a semicolon. Here is an example of an Cloud Dataproc API snippet that uses a QueryList to specify a HiveJob: "hiveJob": { "queryList": { "queries": [ "query1", "query2", "query3;query4", ] } }
- SoftwareConfig::getImageVersion() — Method in class SoftwareConfig
- Optional. The version of software inside the cluster. It must match the
regular expression
[0-9]+\.[0-9]+. If unspecified, it defaults to the latest version (see Cloud Dataproc Versioning). - SoftwareConfig::getProperties() — Method in class SoftwareConfig
- Optional. The properties to set on daemon config files.
- SparkJob::getMainJarFileUri() — Method in class SparkJob
- The HCFS URI of the jar file that contains the main class.
- SparkJob::getMainClass() — Method in class SparkJob
- The name of the driver's main class. The jar file that contains the class
must be in the default CLASSPATH or specified in
jar_file_uris. - SparkJob::getArgs() — Method in class SparkJob
- Optional. The arguments to pass to the driver. Do not include arguments,
such as
--conf, that can be set as job properties, since a collision may occur that causes an incorrect job submission. - SparkJob::getJarFileUris() — Method in class SparkJob
- Optional. HCFS URIs of jar files to add to the CLASSPATHs of the Spark driver and tasks.
- SparkJob::getFileUris() — Method in class SparkJob
- Optional. HCFS URIs of files to be copied to the working directory of Spark drivers and distributed tasks. Useful for naively parallel tasks.
- SparkJob::getArchiveUris() — Method in class SparkJob
- Optional. HCFS URIs of archives to be extracted in the working directory of Spark drivers and tasks. Supported file types:
- SparkJob::getProperties() — Method in class SparkJob
- Optional. A mapping of property names to values, used to configure Spark.
- SparkJob::getLoggingConfig() — Method in class SparkJob
- Optional. The runtime log config for job execution.
- SparkJob::getDriver() — Method in class SparkJob
- SparkSqlJob::getQueryFileUri() — Method in class SparkSqlJob
- The HCFS URI of the script that contains SQL queries.
- SparkSqlJob::getQueryList() — Method in class SparkSqlJob
- A list of queries.
- SparkSqlJob::getScriptVariables() — Method in class SparkSqlJob
- Optional. Mapping of query variable names to values (equivalent to the
Spark SQL command: SET
name="value";). - SparkSqlJob::getProperties() — Method in class SparkSqlJob
- Optional. A mapping of property names to values, used to configure Spark SQL's SparkConf. Properties that conflict with values set by the Cloud Dataproc API may be overwritten.
- SparkSqlJob::getJarFileUris() — Method in class SparkSqlJob
- Optional. HCFS URIs of jar files to be added to the Spark CLASSPATH.
- SparkSqlJob::getLoggingConfig() — Method in class SparkSqlJob
- Optional. The runtime log config for job execution.
- SparkSqlJob::getQueries() — Method in class SparkSqlJob
- SubmitJobRequest::getProjectId() — Method in class SubmitJobRequest
- Required. The ID of the Google Cloud Platform project that the job belongs to.
- SubmitJobRequest::getRegion() — Method in class SubmitJobRequest
- Required. The Cloud Dataproc region in which to handle the request.
- SubmitJobRequest::getJob() — Method in class SubmitJobRequest
- Required. The job resource.
- UpdateClusterRequest::getProjectId() — Method in class UpdateClusterRequest
- Required. The ID of the Google Cloud Platform project the cluster belongs to.
- UpdateClusterRequest::getRegion() — Method in class UpdateClusterRequest
- Required. The Cloud Dataproc region in which to handle the request.
- UpdateClusterRequest::getClusterName() — Method in class UpdateClusterRequest
- Required. The cluster name.
- UpdateClusterRequest::getCluster() — Method in class UpdateClusterRequest
- Required. The changes to the cluster.
- UpdateClusterRequest::getUpdateMask() — Method in class UpdateClusterRequest
- Required. Specifies the path, relative to
Cluster, of the field to update. For example, to change the number of workers in a cluster to 5, theupdate_maskparameter would be specified asconfig.worker_config.num_instances, and thePATCHrequest body would specify the new value, as follows: { "config":{ "workerConfig":{ "numInstances":"5" } } } Similarly, to change the number of preemptible workers in a cluster to 5, theupdate_maskparameter would beconfig.secondary_worker_config.num_instances, and thePATCHrequest body would be set as follows: { "config":{ "secondaryWorkerConfig":{ "numInstances":"5" } } } Note: Currently, only the following fields can be updated:Mask Purpose labels Update labels config.worker_config.num_instances Resize primary worker group config.secondary_worker_config.num_instances Resize secondary worker group - UpdateJobRequest::getProjectId() — Method in class UpdateJobRequest
- Required. The ID of the Google Cloud Platform project that the job belongs to.
- UpdateJobRequest::getRegion() — Method in class UpdateJobRequest
- Required. The Cloud Dataproc region in which to handle the request.
- UpdateJobRequest::getJobId() — Method in class UpdateJobRequest
- Required. The job ID.
- UpdateJobRequest::getJob() — Method in class UpdateJobRequest
- Required. The changes to the job.
- UpdateJobRequest::getUpdateMask() — Method in class UpdateJobRequest
- Required. Specifies the path, relative to
Job, of the field to update. For example, to update the labels of a Job theupdate_maskparameter would be specified aslabels, and thePATCHrequest body would specify the new value. Note: Currently,labelsis the only field that can be updated. - YarnApplication::getName() — Method in class YarnApplication
- Required. The application name.
- YarnApplication::getState() — Method in class YarnApplication
- Required. The application state.
- YarnApplication::getProgress() — Method in class YarnApplication
- Required. The numerical progress of the application, from 1 to 100.
- YarnApplication::getTrackingUrl() — Method in class YarnApplication
- Optional. The HTTP URL of the ApplicationMaster, HistoryServer, or TimelineServer that provides application-specific information. The URL uses the internal hostname, and requires a proxy server for resolution and, possibly, access.
- Breakpoint::getId() — Method in class Breakpoint
- Breakpoint identifier, unique in the scope of the debuggee.
- Breakpoint::getAction() — Method in class Breakpoint
- Action that the agent should perform when the code at the breakpoint location is hit.
- Breakpoint::getLocation() — Method in class Breakpoint
- Breakpoint source location.
- Breakpoint::getCondition() — Method in class Breakpoint
- Condition that triggers the breakpoint.
- Breakpoint::getExpressions() — Method in class Breakpoint
- List of read-only expressions to evaluate at the breakpoint location.
- Breakpoint::getLogMessageFormat() — Method in class Breakpoint
- Only relevant when action is
LOG. Defines the message to log when the breakpoint hits. The message may include parameter placeholders$0,$1, etc. These placeholders are replaced with the evaluated value of the appropriate expression. Expressions not referenced inlog_message_formatare not logged. - Breakpoint::getLogLevel() — Method in class Breakpoint
- Indicates the severity of the log. Only relevant when action is
LOG. - Breakpoint::getIsFinalState() — Method in class Breakpoint
- When true, indicates that this is a final result and the breakpoint state will not change from here on.
- Breakpoint::getCreateTime() — Method in class Breakpoint
- Time this breakpoint was created by the server in seconds resolution.
- Breakpoint::getFinalTime() — Method in class Breakpoint
- Time this breakpoint was finalized as seen by the server in seconds resolution.
- Breakpoint::getUserEmail() — Method in class Breakpoint
- E-mail address of the user that created this breakpoint
- Breakpoint::getStatus() — Method in class Breakpoint
- Breakpoint status.
- Breakpoint::getStackFrames() — Method in class Breakpoint
- The stack at breakpoint time.
- Breakpoint::getEvaluatedExpressions() — Method in class Breakpoint
- Values of evaluated expressions at breakpoint time.
- Breakpoint::getVariableTable() — Method in class Breakpoint
- The
variable_tableexists to aid with computation, memory and network traffic optimization. It enables storing a variable once and reference it from multiple variables, including variables stored in thevariable_tableitself. - Breakpoint::getLabels() — Method in class Breakpoint
- A set of custom breakpoint properties, populated by the agent, to be displayed to the user.
- Debuggee::getId() — Method in class Debuggee
- Unique identifier for the debuggee generated by the controller service.
- Debuggee::getProject() — Method in class Debuggee
- Project the debuggee is associated with.
- Debuggee::getUniquifier() — Method in class Debuggee
- Uniquifier to further distiguish the application.
- Debuggee::getDescription() — Method in class Debuggee
- Human readable description of the debuggee.
- Debuggee::getIsInactive() — Method in class Debuggee
- If set to
true, indicates that Controller service does not detect any activity from the debuggee agents and the application is possibly stopped. - Debuggee::getAgentVersion() — Method in class Debuggee
- Version ID of the agent.
- Debuggee::getIsDisabled() — Method in class Debuggee
- If set to
true, indicates that the agent should disable itself and detach from the debuggee. - Debuggee::getStatus() — Method in class Debuggee
- Human readable message to be displayed to the user about this debuggee.
- Debuggee::getSourceContexts() — Method in class Debuggee
- References to the locations and revisions of the source code used in the deployed application.
- Debuggee::getExtSourceContexts() — Method in class Debuggee
- References to the locations and revisions of the source code used in the deployed application.
- Debuggee::getLabels() — Method in class Debuggee
- A set of custom debuggee properties, populated by the agent, to be displayed to the user.
- Debugger2GrpcClient::GetBreakpoint() — Method in class Debugger2GrpcClient
- Gets breakpoint information.
- DeleteBreakpointRequest::getDebuggeeId() — Method in class DeleteBreakpointRequest
- ID of the debuggee whose breakpoint to delete.
- DeleteBreakpointRequest::getBreakpointId() — Method in class DeleteBreakpointRequest
- ID of the breakpoint to delete.
- DeleteBreakpointRequest::getClientVersion() — Method in class DeleteBreakpointRequest
- The client version making the call.
- FormatMessage::getFormat() — Method in class FormatMessage
- Format template for the message. The
formatuses placeholders$0,$1, etc. to reference parameters.$$can be used to denote the$character. - FormatMessage::getParameters() — Method in class FormatMessage
- Optional parameters to be embedded into the message.
- GetBreakpointRequest — Class in namespace Google\Cloud\Debugger\V2
- Request to get breakpoint information.
- GetBreakpointRequest::getDebuggeeId() — Method in class GetBreakpointRequest
- ID of the debuggee whose breakpoint to get.
- GetBreakpointRequest::getBreakpointId() — Method in class GetBreakpointRequest
- ID of the breakpoint to get.
- GetBreakpointRequest::getClientVersion() — Method in class GetBreakpointRequest
- The client version making the call.
- GetBreakpointResponse — Class in namespace Google\Cloud\Debugger\V2
- Response for getting breakpoint information.
- GetBreakpointResponse::getBreakpoint() — Method in class GetBreakpointResponse
- Complete breakpoint state.
- ListActiveBreakpointsRequest::getDebuggeeId() — Method in class ListActiveBreakpointsRequest
- Identifies the debuggee.
- ListActiveBreakpointsRequest::getWaitToken() — Method in class ListActiveBreakpointsRequest
- A token that, if specified, blocks the method call until the list
of active breakpoints has changed, or a server-selected timeout has
expired. The value should be set from the
next_wait_tokenfield in the last response. The initial value should be set to"init". - ListActiveBreakpointsRequest::getSuccessOnTimeout() — Method in class ListActiveBreakpointsRequest
- If set to
true(recommended), returnsgoogle.rpc.Code.OKstatus and sets thewait_expiredresponse field totruewhen the server-selected timeout has expired. - ListActiveBreakpointsResponse::getBreakpoints() — Method in class ListActiveBreakpointsResponse
- List of all active breakpoints.
- ListActiveBreakpointsResponse::getNextWaitToken() — Method in class ListActiveBreakpointsResponse
- A token that can be used in the next method call to block until the list of breakpoints changes.
- ListActiveBreakpointsResponse::getWaitExpired() — Method in class ListActiveBreakpointsResponse
- If set to
true, indicates that there is no change to the list of active breakpoints and the server-selected timeout has expired. - ListBreakpointsRequest::getDebuggeeId() — Method in class ListBreakpointsRequest
- ID of the debuggee whose breakpoints to list.
- ListBreakpointsRequest::getIncludeAllUsers() — Method in class ListBreakpointsRequest
- When set to
true, the response includes the list of breakpoints set by any user. Otherwise, it includes only breakpoints set by the caller. - ListBreakpointsRequest::getIncludeInactive() — Method in class ListBreakpointsRequest
- When set to
true, the response includes active and inactive breakpoints. Otherwise, it includes only active breakpoints. - ListBreakpointsRequest::getAction() — Method in class ListBreakpointsRequest
- When set, the response includes only breakpoints with the specified action.
- ListBreakpointsRequest::getStripResults() — Method in class ListBreakpointsRequest
- This field is deprecated. The following fields are always stripped out of
the result:
stack_frames,evaluated_expressionsandvariable_table. - ListBreakpointsRequest::getWaitToken() — Method in class ListBreakpointsRequest
- A wait token that, if specified, blocks the call until the breakpoints
list has changed, or a server selected timeout has expired. The value
should be set from the last response. The error code
google.rpc.Code.ABORTED(RPC) is returned on wait timeout, which should be called again with the samewait_token. - ListBreakpointsRequest::getClientVersion() — Method in class ListBreakpointsRequest
- The client version making the call.
- ListBreakpointsRequest_BreakpointActionValue::getValue() — Method in class ListBreakpointsRequest_BreakpointActionValue
- Only breakpoints with the specified action will pass the filter.
- ListBreakpointsResponse::getBreakpoints() — Method in class ListBreakpointsResponse
- List of breakpoints matching the request.
- ListBreakpointsResponse::getNextWaitToken() — Method in class ListBreakpointsResponse
- A wait token that can be used in the next call to
list(REST) orListBreakpoints(RPC) to block until the list of breakpoints has changes. - ListDebuggeesRequest::getProject() — Method in class ListDebuggeesRequest
- Project number of a Google Cloud project whose debuggees to list.
- ListDebuggeesRequest::getIncludeInactive() — Method in class ListDebuggeesRequest
- When set to
true, the result includes all debuggees. Otherwise, the result includes only debuggees that are active. - ListDebuggeesRequest::getClientVersion() — Method in class ListDebuggeesRequest
- The client version making the call.
- ListDebuggeesResponse::getDebuggees() — Method in class ListDebuggeesResponse
- List of debuggees accessible to the calling user.
- RegisterDebuggeeRequest::getDebuggee() — Method in class RegisterDebuggeeRequest
- Debuggee information to register.
- RegisterDebuggeeResponse::getDebuggee() — Method in class RegisterDebuggeeResponse
- Debuggee resource.
- SetBreakpointRequest::getDebuggeeId() — Method in class SetBreakpointRequest
- ID of the debuggee where the breakpoint is to be set.
- SetBreakpointRequest::getBreakpoint() — Method in class SetBreakpointRequest
- Breakpoint specification to set.
- SetBreakpointRequest::getClientVersion() — Method in class SetBreakpointRequest
- The client version making the call.
- SetBreakpointResponse::getBreakpoint() — Method in class SetBreakpointResponse
- Breakpoint resource.
- SourceLocation::getPath() — Method in class SourceLocation
- Path to the source file within the source context of the target binary.
- SourceLocation::getLine() — Method in class SourceLocation
- Line inside the file. The first line in the file has the value
1. - StackFrame::getFunction() — Method in class StackFrame
- Demangled function name at the call site.
- StackFrame::getLocation() — Method in class StackFrame
- Source location of the call site.
- StackFrame::getArguments() — Method in class StackFrame
- Set of arguments passed to this function.
- StackFrame::getLocals() — Method in class StackFrame
- Set of local variables at the stack frame location.
- StatusMessage::getIsError() — Method in class StatusMessage
- Distinguishes errors from informational messages.
- StatusMessage::getRefersTo() — Method in class StatusMessage
- Reference to which the message applies.
- StatusMessage::getDescription() — Method in class StatusMessage
- Status message text.
- UpdateActiveBreakpointRequest::getDebuggeeId() — Method in class UpdateActiveBreakpointRequest
- Identifies the debuggee being debugged.
- UpdateActiveBreakpointRequest::getBreakpoint() — Method in class UpdateActiveBreakpointRequest
- Updated breakpoint information.
- Variable::getName() — Method in class Variable
- Name of the variable, if any.
- Variable::getValue() — Method in class Variable
- Simple value of the variable.
- Variable::getType() — Method in class Variable
- Variable type (e.g.
MyClass). If the variable is split withvar_table_index,typegoes next tovalue. The interpretation of a type is agent specific. It is recommended to include the dynamic type rather than a static type of an object. - Variable::getMembers() — Method in class Variable
- Members contained or pointed to by the variable.
- Variable::getVarTableIndex() — Method in class Variable
- Reference to a variable in the shared variable table. More than
one variable can reference the same variable in the table. The
var_table_indexfield is an index intovariable_tablein Breakpoint. - Variable::getStatus() — Method in class Variable
- Status associated with the variable. This field will usually stay unset. A status of a single variable only applies to that variable or expression. The rest of breakpoint data still remains valid. Variables might be reported in error state even when breakpoint is not in final state.
- AliasContext::getKind() — Method in class AliasContext
- The alias kind.
- AliasContext::getName() — Method in class AliasContext
- The alias name.
- CloudRepoSourceContext::getRepoId() — Method in class CloudRepoSourceContext
- The ID of the repo.
- CloudRepoSourceContext::getRevisionId() — Method in class CloudRepoSourceContext
- A revision ID.
- CloudRepoSourceContext::getAliasName() — Method in class CloudRepoSourceContext
- The name of an alias (branch, tag, etc.).
- CloudRepoSourceContext::getAliasContext() — Method in class CloudRepoSourceContext
- An alias, which may be a branch or tag.
- CloudRepoSourceContext::getRevision() — Method in class CloudRepoSourceContext
- CloudWorkspaceId::getRepoId() — Method in class CloudWorkspaceId
- The ID of the repo containing the workspace.
- CloudWorkspaceId::getName() — Method in class CloudWorkspaceId
- The unique name of the workspace within the repo. This is the name chosen by the client in the Source API's CreateWorkspace method.
- CloudWorkspaceSourceContext::getWorkspaceId() — Method in class CloudWorkspaceSourceContext
- The ID of the workspace.
- CloudWorkspaceSourceContext::getSnapshotId() — Method in class CloudWorkspaceSourceContext
- The ID of the snapshot.
- ExtendedSourceContext::getContext() — Method in class ExtendedSourceContext
- Any source context.
- ExtendedSourceContext::getLabels() — Method in class ExtendedSourceContext
- Labels with user defined metadata.
- GerritSourceContext — Class in namespace Google\Cloud\DevTools\Source\V1
- A SourceContext referring to a Gerrit project.
- GerritSourceContext::getHostUri() — Method in class GerritSourceContext
- The URI of a running Gerrit instance.
- GerritSourceContext::getGerritProject() — Method in class GerritSourceContext
- The full project name within the host. Projects may be nested, so "project/subproject" is a valid project name.
- GerritSourceContext::getRevisionId() — Method in class GerritSourceContext
- A revision (commit) ID.
- GerritSourceContext::getAliasName() — Method in class GerritSourceContext
- The name of an alias (branch, tag, etc.).
- GerritSourceContext::getAliasContext() — Method in class GerritSourceContext
- An alias, which may be a branch or tag.
- GerritSourceContext::getRevision() — Method in class GerritSourceContext
- GitSourceContext — Class in namespace Google\Cloud\DevTools\Source\V1
- A GitSourceContext denotes a particular revision in a third party Git repository (e.g. GitHub).
- GitSourceContext::getUrl() — Method in class GitSourceContext
- Git repository URL.
- GitSourceContext::getRevisionId() — Method in class GitSourceContext
- Git commit hash.
- ProjectRepoId::getProjectId() — Method in class ProjectRepoId
- The ID of the project.
- ProjectRepoId::getRepoName() — Method in class ProjectRepoId
- The name of the repo. Leave empty for the default repo.
- RepoId::getProjectRepoId() — Method in class RepoId
- A combination of a project ID and a repo name.
- RepoId::getUid() — Method in class RepoId
- A server-assigned, globally unique identifier.
- RepoId::getId() — Method in class RepoId
- SourceContext::getCloudRepo() — Method in class SourceContext
- A SourceContext referring to a revision in a cloud repo.
- SourceContext::getCloudWorkspace() — Method in class SourceContext
- A SourceContext referring to a snapshot in a cloud workspace.
- SourceContext::getGerrit() — Method in class SourceContext
- A SourceContext referring to a Gerrit project.
- SourceContext::getGit() — Method in class SourceContext
- A SourceContext referring to any third party Git repo (e.g. GitHub).
- SourceContext::getContext() — Method in class SourceContext
- Agent::getParent() — Method in class Agent
- Required. The project of this agent.
- Agent::getDisplayName() — Method in class Agent
- Required. The name of this agent.
- Agent::getDefaultLanguageCode() — Method in class Agent
- Required. The default language of the agent as a language tag. See Language Support for a list of the currently supported language codes.
- Agent::getSupportedLanguageCodes() — Method in class Agent
- Optional. The list of all languages supported by this agent (except for the
default_language_code). - Agent::getTimeZone() — Method in class Agent
- Required. The time zone of this agent from the time zone database, e.g., America/New_York, Europe/Paris.
- Agent::getDescription() — Method in class Agent
- Optional. The description of this agent.
- Agent::getAvatarUri() — Method in class Agent
- Optional. The URI of the agent's avatar.
- Agent::getEnableLogging() — Method in class Agent
- Optional. Determines whether this agent should log conversation queries.
- Agent::getMatchMode() — Method in class Agent
- Optional. Determines how intents are detected from user queries.
- Agent::getClassificationThreshold() — Method in class Agent
- Optional. To filter out false positive results and still get variety in matched natural language inputs for your agent, you can tune the machine learning classification threshold. If the returned score value is less than the threshold value, then a fallback intent is be triggered or, if there are no fallback intents defined, no intent will be triggered. The score values range from 0.0 (completely uncertain) to 1.0 (completely certain).
- AgentsGrpcClient::GetAgent() — Method in class AgentsGrpcClient
- Retrieves the specified agent.
- BatchCreateEntitiesRequest::getParent() — Method in class BatchCreateEntitiesRequest
- Required. The name of the entity type to create entities in. Format:
projects/<Project ID>/agent/entityTypes/<Entity Type ID>. - BatchCreateEntitiesRequest::getEntities() — Method in class BatchCreateEntitiesRequest
- Required. The collection of entities to create.
- BatchCreateEntitiesRequest::getLanguageCode() — Method in class BatchCreateEntitiesRequest
- Optional. The language of entity synonyms defined in
entities. If not specified, the agent's default language is used. - BatchDeleteEntitiesRequest::getParent() — Method in class BatchDeleteEntitiesRequest
- Required. The name of the entity type to delete entries for. Format:
projects/<Project ID>/agent/entityTypes/<Entity Type ID>. - BatchDeleteEntitiesRequest::getEntityValues() — Method in class BatchDeleteEntitiesRequest
- Required. The canonical
valuesof the entities to delete. Note that these are not fully-qualified names, i.e. they don't start withprojects/<Project ID>. - BatchDeleteEntitiesRequest::getLanguageCode() — Method in class BatchDeleteEntitiesRequest
- Optional. The language of entity synonyms defined in
entities. If not specified, the agent's default language is used. - BatchDeleteEntityTypesRequest::getParent() — Method in class BatchDeleteEntityTypesRequest
- Required. The name of the agent to delete all entities types for. Format:
projects/<Project ID>/agent. - BatchDeleteEntityTypesRequest::getEntityTypeNames() — Method in class BatchDeleteEntityTypesRequest
- Required. The names entity types to delete. All names must point to the
same agent as
parent. - BatchDeleteIntentsRequest::getParent() — Method in class BatchDeleteIntentsRequest
- Required. The name of the agent to delete all entities types for. Format:
projects/<Project ID>/agent. - BatchDeleteIntentsRequest::getIntents() — Method in class BatchDeleteIntentsRequest
- Required. The collection of intents to delete. Only intent
namemust be filled in. - BatchUpdateEntitiesRequest::getParent() — Method in class BatchUpdateEntitiesRequest
- Required. The name of the entity type to update the entities in. Format:
projects/<Project ID>/agent/entityTypes/<Entity Type ID>. - BatchUpdateEntitiesRequest::getEntities() — Method in class BatchUpdateEntitiesRequest
- Required. The collection of new entities to replace the existing entities.
- BatchUpdateEntitiesRequest::getLanguageCode() — Method in class BatchUpdateEntitiesRequest
- Optional. The language of entity synonyms defined in
entities. If not specified, the agent's default language is used. - BatchUpdateEntitiesRequest::getUpdateMask() — Method in class BatchUpdateEntitiesRequest
- Optional. The mask to control which fields get updated.
- BatchUpdateEntityTypesRequest::getParent() — Method in class BatchUpdateEntityTypesRequest
- Required. The name of the agent to update or create entity types in.
- BatchUpdateEntityTypesRequest::getEntityTypeBatchUri() — Method in class BatchUpdateEntityTypesRequest
- The URI to a Google Cloud Storage file containing entity types to update or create. The file format can either be a serialized proto (of EntityBatch type) or a JSON object. Note: The URI must start with "gs://".
- BatchUpdateEntityTypesRequest::getEntityTypeBatchInline() — Method in class BatchUpdateEntityTypesRequest
- The collection of entity type to update or create.
- BatchUpdateEntityTypesRequest::getLanguageCode() — Method in class BatchUpdateEntityTypesRequest
- Optional. The language of entity synonyms defined in
entity_types. If not specified, the agent's default language is used. - BatchUpdateEntityTypesRequest::getUpdateMask() — Method in class BatchUpdateEntityTypesRequest
- Optional. The mask to control which fields get updated.
- BatchUpdateEntityTypesRequest::getEntityTypeBatch() — Method in class BatchUpdateEntityTypesRequest
- BatchUpdateEntityTypesResponse::getEntityTypes() — Method in class BatchUpdateEntityTypesResponse
- The collection of updated or created entity types.
- BatchUpdateIntentsRequest::getParent() — Method in class BatchUpdateIntentsRequest
- Required. The name of the agent to update or create intents in.
- BatchUpdateIntentsRequest::getIntentBatchUri() — Method in class BatchUpdateIntentsRequest
- The URI to a Google Cloud Storage file containing intents to update or create. The file format can either be a serialized proto (of IntentBatch type) or JSON object. Note: The URI must start with "gs://".
- BatchUpdateIntentsRequest::getIntentBatchInline() — Method in class BatchUpdateIntentsRequest
- The collection of intents to update or create.
- BatchUpdateIntentsRequest::getLanguageCode() — Method in class BatchUpdateIntentsRequest
- Optional. The language of training phrases, parameters and rich messages
defined in
intents. If not specified, the agent's default language is used. More than a dozen languages are supported. - BatchUpdateIntentsRequest::getUpdateMask() — Method in class BatchUpdateIntentsRequest
- Optional. The mask to control which fields get updated.
- BatchUpdateIntentsRequest::getIntentView() — Method in class BatchUpdateIntentsRequest
- Optional. The resource view to apply to the returned intent.
- BatchUpdateIntentsRequest::getIntentBatch() — Method in class BatchUpdateIntentsRequest
- BatchUpdateIntentsResponse::getIntents() — Method in class BatchUpdateIntentsResponse
- The collection of updated or created intents.
- Context::getName() — Method in class Context
- Required. The unique identifier of the context. Format:
projects/<Project ID>/agent/sessions/<Session ID>/contexts/<Context ID>. - Context::getLifespanCount() — Method in class Context
- Optional. The number of conversational query requests after which the
context expires. If set to
0(the default) the context expires immediately. Contexts expire automatically after 10 minutes even if there are no matching queries. - Context::getParameters() — Method in class Context
- Optional. The collection of parameters associated with this context.
- ContextsGrpcClient::GetContext() — Method in class ContextsGrpcClient
- Retrieves the specified context.
- CreateContextRequest::getParent() — Method in class CreateContextRequest
- Required. The session to create a context for.
- CreateContextRequest::getContext() — Method in class CreateContextRequest
- Required. The context to create.
- CreateEntityTypeRequest::getParent() — Method in class CreateEntityTypeRequest
- Required. The agent to create a entity type for.
- CreateEntityTypeRequest::getEntityType() — Method in class CreateEntityTypeRequest
- Required. The entity type to create.
- CreateEntityTypeRequest::getLanguageCode() — Method in class CreateEntityTypeRequest
- Optional. The language of entity synonyms defined in
entity_type. If not specified, the agent's default language is used. - CreateIntentRequest::getParent() — Method in class CreateIntentRequest
- Required. The agent to create a intent for.
- CreateIntentRequest::getIntent() — Method in class CreateIntentRequest
- Required. The intent to create.
- CreateIntentRequest::getLanguageCode() — Method in class CreateIntentRequest
- Optional. The language of training phrases, parameters and rich messages
defined in
intent. If not specified, the agent's default language is used. More than a dozen languages are supported. - CreateIntentRequest::getIntentView() — Method in class CreateIntentRequest
- Optional. The resource view to apply to the returned intent.
- CreateSessionEntityTypeRequest::getParent() — Method in class CreateSessionEntityTypeRequest
- Required. The session to create a session entity type for.
- CreateSessionEntityTypeRequest::getSessionEntityType() — Method in class CreateSessionEntityTypeRequest
- Required. The session entity type to create.
- DeleteAllContextsRequest::getParent() — Method in class DeleteAllContextsRequest
- Required. The name of the session to delete all contexts from. Format:
projects/<Project ID>/agent/sessions/<Session ID>. - DeleteContextRequest::getName() — Method in class DeleteContextRequest
- Required. The name of the context to delete. Format:
projects/<Project ID>/agent/sessions/<Session ID>/contexts/<Context ID>. - DeleteEntityTypeRequest::getName() — Method in class DeleteEntityTypeRequest
- Required. The name of the entity type to delete.
- DeleteIntentRequest::getName() — Method in class DeleteIntentRequest
- Required. The name of the intent to delete.
- DeleteSessionEntityTypeRequest::getName() — Method in class DeleteSessionEntityTypeRequest
- Required. The name of the entity type to delete. Format:
projects/<Project ID>/agent/sessions/<Session ID>/entityTypes/<Entity Type Display Name>. - DetectIntentRequest::getSession() — Method in class DetectIntentRequest
- Required. The name of the session this query is sent to. Format:
projects/<Project ID>/agent/sessions/<Session ID>. It's up to the API caller to choose an appropriate session ID. It can be a random number or some type of user identifier (preferably hashed). The length of the session ID must not exceed 36 bytes. - DetectIntentRequest::getQueryParams() — Method in class DetectIntentRequest
- Optional. The parameters of this query.
- DetectIntentRequest::getQueryInput() — Method in class DetectIntentRequest
- Required. The input specification. It can be set to: 1. an audio config which instructs the speech recognizer how to process the speech audio, 2. a conversational query in the form of text, or 3. an event that specifies which intent to trigger.
- DetectIntentRequest::getInputAudio() — Method in class DetectIntentRequest
- Optional. The natural language speech audio to be processed. This field
should be populated iff
query_inputis set to an input audio config. - DetectIntentResponse::getResponseId() — Method in class DetectIntentResponse
- The unique identifier of the response. It can be used to locate a response in the training example set or for reporting issues.
- DetectIntentResponse::getQueryResult() — Method in class DetectIntentResponse
- The results of the conversational query or event processing.
- DetectIntentResponse::getWebhookStatus() — Method in class DetectIntentResponse
- Specifies the status of the webhook request.
webhook_statusis never populated in webhook requests. - EntityType::getName() — Method in class EntityType
- Required for all methods except
create(createpopulates the name automatically. - EntityType::getDisplayName() — Method in class EntityType
- Required. The name of the entity.
- EntityType::getKind() — Method in class EntityType
- Required. Indicates the kind of entity type.
- EntityType::getAutoExpansionMode() — Method in class EntityType
- Optional. Indicates whether the entity type can be automatically expanded.
- EntityType::getEntities() — Method in class EntityType
- Optional. The collection of entities associated with the entity type.
- EntityTypeBatch::getEntityTypes() — Method in class EntityTypeBatch
- A collection of entity types.
- EntityType_Entity::getValue() — Method in class EntityType_Entity
- Required.
- EntityType_Entity::getSynonyms() — Method in class EntityType_Entity
- Required. A collection of synonyms. For
KIND_LISTentity types this must contain exactly one synonym equal tovalue. - EntityTypesGrpcClient::GetEntityType() — Method in class EntityTypesGrpcClient
- Retrieves the specified entity type.
- EventInput::getName() — Method in class EventInput
- Required. The unique identifier of the event.
- EventInput::getParameters() — Method in class EventInput
- Optional. The collection of parameters associated with the event.
- EventInput::getLanguageCode() — Method in class EventInput
- Required. The language of this query. See Language Support for a list of the currently supported language codes. Note that queries in the same session do not necessarily need to specify the same language.
- ExportAgentRequest::getParent() — Method in class ExportAgentRequest
- Required. The project that the agent to export is associated with.
- ExportAgentRequest::getAgentUri() — Method in class ExportAgentRequest
- Optional. The Google Cloud Storage URI to export the agent to.
- ExportAgentResponse::getAgentUri() — Method in class ExportAgentResponse
- The URI to a file containing the exported agent. This field is populated
only if
agent_uriis specified inExportAgentRequest. - ExportAgentResponse::getAgentContent() — Method in class ExportAgentResponse
- The exported agent.
- ExportAgentResponse::getAgent() — Method in class ExportAgentResponse
- GetAgentRequest — Class in namespace Google\Cloud\Dialogflow\V2
- The request message for [Agents.GetAgent][google.cloud.dialogflow.v2.Agents.GetAgent].
- GetAgentRequest::getParent() — Method in class GetAgentRequest
- Required. The project that the agent to fetch is associated with.
- GetContextRequest — Class in namespace Google\Cloud\Dialogflow\V2
- The request message for [Contexts.GetContext][google.cloud.dialogflow.v2.Contexts.GetContext].
- GetContextRequest::getName() — Method in class GetContextRequest
- Required. The name of the context. Format:
projects/<Project ID>/agent/sessions/<Session ID>/contexts/<Context ID>. - GetEntityTypeRequest — Class in namespace Google\Cloud\Dialogflow\V2
- The request message for [EntityTypes.GetEntityType][google.cloud.dialogflow.v2.EntityTypes.GetEntityType].
- GetEntityTypeRequest::getName() — Method in class GetEntityTypeRequest
- Required. The name of the entity type.
- GetEntityTypeRequest::getLanguageCode() — Method in class GetEntityTypeRequest
- Optional. The language to retrieve entity synonyms for. If not specified, the agent's default language is used.
- GetIntentRequest — Class in namespace Google\Cloud\Dialogflow\V2
- The request message for [Intents.GetIntent][google.cloud.dialogflow.v2.Intents.GetIntent].
- GetIntentRequest::getName() — Method in class GetIntentRequest
- Required. The name of the intent.
- GetIntentRequest::getLanguageCode() — Method in class GetIntentRequest
- Optional. The language to retrieve training phrases, parameters and rich messages for. If not specified, the agent's default language is used.
- GetIntentRequest::getIntentView() — Method in class GetIntentRequest
- Optional. The resource view to apply to the returned intent.
- GetSessionEntityTypeRequest — Class in namespace Google\Cloud\Dialogflow\V2
- The request message for [SessionEntityTypes.GetSessionEntityType][google.cloud.dialogflow.v2.SessionEntityTypes.GetSessionEntityType].
- GetSessionEntityTypeRequest::getName() — Method in class GetSessionEntityTypeRequest
- Required. The name of the session entity type. Format:
projects/<Project ID>/agent/sessions/<Session ID>/entityTypes/<Entity Type Display Name>. - ImportAgentRequest::getParent() — Method in class ImportAgentRequest
- Required. The project that the agent to import is associated with.
- ImportAgentRequest::getAgentUri() — Method in class ImportAgentRequest
- The URI to a Google Cloud Storage file containing the agent to import.
- ImportAgentRequest::getAgentContent() — Method in class ImportAgentRequest
- The agent to import.
- ImportAgentRequest::getAgent() — Method in class ImportAgentRequest
- InputAudioConfig::getAudioEncoding() — Method in class InputAudioConfig
- Required. Audio encoding of the audio content to process.
- InputAudioConfig::getSampleRateHertz() — Method in class InputAudioConfig
- Required. Sample rate (in Hertz) of the audio content sent in the query.
- InputAudioConfig::getLanguageCode() — Method in class InputAudioConfig
- Required. The language of the supplied audio. Dialogflow does not do translations. See Language Support for a list of the currently supported language codes. Note that queries in the same session do not necessarily need to specify the same language.
- InputAudioConfig::getPhraseHints() — Method in class InputAudioConfig
- Optional. The collection of phrase hints which are used to boost accuracy of speech recognition.
- Intent::getName() — Method in class Intent
- Required for all methods except
create(createpopulates the name automatically. - Intent::getDisplayName() — Method in class Intent
- Required. The name of this intent.
- Intent::getWebhookState() — Method in class Intent
- Required. Indicates whether webhooks are enabled for the intent.
- Intent::getPriority() — Method in class Intent
- Optional. The priority of this intent. Higher numbers represent higher priorities. Zero or negative numbers mean that the intent is disabled.
- Intent::getIsFallback() — Method in class Intent
- Optional. Indicates whether this is a fallback intent.
- Intent::getMlDisabled() — Method in class Intent
- Optional. Indicates whether Machine Learning is disabled for the intent.
- Intent::getInputContextNames() — Method in class Intent
- Optional. The list of context names required for this intent to be triggered.
- Intent::getEvents() — Method in class Intent
- Optional. The collection of event names that trigger the intent.
- Intent::getTrainingPhrases() — Method in class Intent
- Optional. The collection of examples/templates that the agent is trained on.
- Intent::getAction() — Method in class Intent
- Optional. The name of the action associated with the intent.
- Intent::getOutputContexts() — Method in class Intent
- Optional. The collection of contexts that are activated when the intent
is matched. Context messages in this collection should not set the
parameters field. Setting the
lifespan_countto 0 will reset the context when the intent is matched. - Intent::getResetContexts() — Method in class Intent
- Optional. Indicates whether to delete all contexts in the current session when this intent is matched.
- Intent::getParameters() — Method in class Intent
- Optional. The collection of parameters associated with the intent.
- Intent::getMessages() — Method in class Intent
- Optional. The collection of rich messages corresponding to the
Responsefield in the Dialogflow console. - Intent::getDefaultResponsePlatforms() — Method in class Intent
- Optional. The list of platforms for which the first response will be taken from among the messages assigned to the DEFAULT_PLATFORM.
- Intent::getRootFollowupIntentName() — Method in class Intent
- The unique identifier of the root intent in the chain of followup intents.
- Intent::getParentFollowupIntentName() — Method in class Intent
- The unique identifier of the parent intent in the chain of followup intents.
- Intent::getFollowupIntentInfo() — Method in class Intent
- Optional. Collection of information about all followup intents that have name of this intent as a root_name.
- IntentBatch::getIntents() — Method in class IntentBatch
- A collection of intents.
- Intent_FollowupIntentInfo::getFollowupIntentName() — Method in class Intent_FollowupIntentInfo
- The unique identifier of the followup intent.
- Intent_FollowupIntentInfo::getParentFollowupIntentName() — Method in class Intent_FollowupIntentInfo
- The unique identifier of the followup intent parent.
- Intent_Message::getText() — Method in class Intent_Message
- The text response.
- Intent_Message::getImage() — Method in class Intent_Message
- The image response.
- Intent_Message::getQuickReplies() — Method in class Intent_Message
- The quick replies response.
- Intent_Message::getCard() — Method in class Intent_Message
- The card response.
- Intent_Message::getPayload() — Method in class Intent_Message
- Returns a response containing a custom, platform-specific payload.
- Intent_Message::getSimpleResponses() — Method in class Intent_Message
- The voice and text-only responses for Actions on Google.
- Intent_Message::getBasicCard() — Method in class Intent_Message
- The basic card response for Actions on Google.
- Intent_Message::getSuggestions() — Method in class Intent_Message
- The suggestion chips for Actions on Google.
- Intent_Message::getLinkOutSuggestion() — Method in class Intent_Message
- The link out suggestion chip for Actions on Google.
- Intent_Message::getListSelect() — Method in class Intent_Message
- The list card response for Actions on Google.
- Intent_Message::getCarouselSelect() — Method in class Intent_Message
- The carousel card response for Actions on Google.
- Intent_Message::getPlatform() — Method in class Intent_Message
- Optional. The platform that this message is intended for.
- Intent_Message::getMessage() — Method in class Intent_Message
- Intent_Message_BasicCard::getTitle() — Method in class Intent_Message_BasicCard
- Optional. The title of the card.
- Intent_Message_BasicCard::getSubtitle() — Method in class Intent_Message_BasicCard
- Optional. The subtitle of the card.
- Intent_Message_BasicCard::getFormattedText() — Method in class Intent_Message_BasicCard
- Required, unless image is present. The body text of the card.
- Intent_Message_BasicCard::getImage() — Method in class Intent_Message_BasicCard
- Optional. The image for the card.
- Intent_Message_BasicCard::getButtons() — Method in class Intent_Message_BasicCard
- Optional. The collection of card buttons.
- Intent_Message_BasicCard_Button::getTitle() — Method in class Intent_Message_BasicCard_Button
- Required. The title of the button.
- Intent_Message_BasicCard_Button::getOpenUriAction() — Method in class Intent_Message_BasicCard_Button
- Required. Action to take when a user taps on the button.
- Intent_Message_BasicCard_Button_OpenUriAction::getUri() — Method in class Intent_Message_BasicCard_Button_OpenUriAction
- Required. The HTTP or HTTPS scheme URI.
- Intent_Message_Card::getTitle() — Method in class Intent_Message_Card
- Optional. The title of the card.
- Intent_Message_Card::getSubtitle() — Method in class Intent_Message_Card
- Optional. The subtitle of the card.
- Intent_Message_Card::getImageUri() — Method in class Intent_Message_Card
- Optional. The public URI to an image file for the card.
- Intent_Message_Card::getButtons() — Method in class Intent_Message_Card
- Optional. The collection of card buttons.
- Intent_Message_Card_Button::getText() — Method in class Intent_Message_Card_Button
- Optional. The text to show on the button.
- Intent_Message_Card_Button::getPostback() — Method in class Intent_Message_Card_Button
- Optional. The text to send back to the Dialogflow API or a URI to open.
- Intent_Message_CarouselSelect::getItems() — Method in class Intent_Message_CarouselSelect
- Required. Carousel items.
- Intent_Message_CarouselSelect_Item::getInfo() — Method in class Intent_Message_CarouselSelect_Item
- Required. Additional info about the option item.
- Intent_Message_CarouselSelect_Item::getTitle() — Method in class Intent_Message_CarouselSelect_Item
- Required. Title of the carousel item.
- Intent_Message_CarouselSelect_Item::getDescription() — Method in class Intent_Message_CarouselSelect_Item
- Optional. The body text of the card.
- Intent_Message_CarouselSelect_Item::getImage() — Method in class Intent_Message_CarouselSelect_Item
- Optional. The image to display.
- Intent_Message_Image::getImageUri() — Method in class Intent_Message_Image
- Optional. The public URI to an image file.
- Intent_Message_Image::getAccessibilityText() — Method in class Intent_Message_Image
- Optional. A text description of the image to be used for accessibility, e.g., screen readers.
- Intent_Message_LinkOutSuggestion::getDestinationName() — Method in class Intent_Message_LinkOutSuggestion
- Required. The name of the app or site this chip is linking to.
- Intent_Message_LinkOutSuggestion::getUri() — Method in class Intent_Message_LinkOutSuggestion
- Required. The URI of the app or site to open when the user taps the suggestion chip.
- Intent_Message_ListSelect::getTitle() — Method in class Intent_Message_ListSelect
- Optional. The overall title of the list.
- Intent_Message_ListSelect::getItems() — Method in class Intent_Message_ListSelect
- Required. List items.
- Intent_Message_ListSelect_Item::getInfo() — Method in class Intent_Message_ListSelect_Item
- Required. Additional information about this option.
- Intent_Message_ListSelect_Item::getTitle() — Method in class Intent_Message_ListSelect_Item
- Required. The title of the list item.
- Intent_Message_ListSelect_Item::getDescription() — Method in class Intent_Message_ListSelect_Item
- Optional. The main text describing the item.
- Intent_Message_ListSelect_Item::getImage() — Method in class Intent_Message_ListSelect_Item
- Optional. The image to display.
- Intent_Message_QuickReplies::getTitle() — Method in class Intent_Message_QuickReplies
- Optional. The title of the collection of quick replies.
- Intent_Message_QuickReplies::getQuickReplies() — Method in class Intent_Message_QuickReplies
- Optional. The collection of quick replies.
- Intent_Message_SelectItemInfo::getKey() — Method in class Intent_Message_SelectItemInfo
- Required. A unique key that will be sent back to the agent if this response is given.
- Intent_Message_SelectItemInfo::getSynonyms() — Method in class Intent_Message_SelectItemInfo
- Optional. A list of synonyms that can also be used to trigger this item in dialog.
- Intent_Message_SimpleResponse::getTextToSpeech() — Method in class Intent_Message_SimpleResponse
- One of text_to_speech or ssml must be provided. The plain text of the speech output. Mutually exclusive with ssml.
- Intent_Message_SimpleResponse::getSsml() — Method in class Intent_Message_SimpleResponse
- One of text_to_speech or ssml must be provided. Structured spoken response to the user in the SSML format. Mutually exclusive with text_to_speech.
- Intent_Message_SimpleResponse::getDisplayText() — Method in class Intent_Message_SimpleResponse
- Optional. The text to display.
- Intent_Message_SimpleResponses::getSimpleResponses() — Method in class Intent_Message_SimpleResponses
- Required. The list of simple responses.
- Intent_Message_Suggestion::getTitle() — Method in class Intent_Message_Suggestion
- Required. The text shown the in the suggestion chip.
- Intent_Message_Suggestions::getSuggestions() — Method in class Intent_Message_Suggestions
- Required. The list of suggested replies.
- Intent_Message_Text::getText() — Method in class Intent_Message_Text
- Optional. The collection of the agent's responses.
- Intent_Parameter::getName() — Method in class Intent_Parameter
- The unique identifier of this parameter.
- Intent_Parameter::getDisplayName() — Method in class Intent_Parameter
- Required. The name of the parameter.
- Intent_Parameter::getValue() — Method in class Intent_Parameter
- Optional. The definition of the parameter value. It can be:
- a constant string,
- a parameter value defined as
$parameter_name, - an original parameter value defined as$parameter_name.original, - a parameter value from some context defined as#context_name.parameter_name. - Intent_Parameter::getDefaultValue() — Method in class Intent_Parameter
- Optional. The default value to use when the
valueyields an empty result. - Intent_Parameter::getEntityTypeDisplayName() — Method in class Intent_Parameter
- Optional. The name of the entity type, prefixed with
@, that describes values of the parameter. If the parameter is required, this must be provided. - Intent_Parameter::getMandatory() — Method in class Intent_Parameter
- Optional. Indicates whether the parameter is required. That is, whether the intent cannot be completed without collecting the parameter value.
- Intent_Parameter::getPrompts() — Method in class Intent_Parameter
- Optional. The collection of prompts that the agent can present to the user in order to collect value for the parameter.
- Intent_Parameter::getIsList() — Method in class Intent_Parameter
- Optional. Indicates whether the parameter represents a list of values.
- Intent_TrainingPhrase::getName() — Method in class Intent_TrainingPhrase
- Required. The unique identifier of this training phrase.
- Intent_TrainingPhrase::getType() — Method in class Intent_TrainingPhrase
- Required. The type of the training phrase.
- Intent_TrainingPhrase::getParts() — Method in class Intent_TrainingPhrase
- Required. The collection of training phrase parts (can be annotated).
- Intent_TrainingPhrase::getTimesAddedCount() — Method in class Intent_TrainingPhrase
- Optional. Indicates how many times this example or template was added to the intent. Each time a developer adds an existing sample by editing an intent or training, this counter is increased.
- Intent_TrainingPhrase_Part::getText() — Method in class Intent_TrainingPhrase_Part
- Required. The text corresponding to the example or template, if there are no annotations. For annotated examples, it is the text for one of the example's parts.
- Intent_TrainingPhrase_Part::getEntityType() — Method in class Intent_TrainingPhrase_Part
- Optional. The entity type name prefixed with
@. This field is required for the annotated part of the text and applies only to examples. - Intent_TrainingPhrase_Part::getAlias() — Method in class Intent_TrainingPhrase_Part
- Optional. The parameter name for the value extracted from the annotated part of the example.
- Intent_TrainingPhrase_Part::getUserDefined() — Method in class Intent_TrainingPhrase_Part
- Optional. Indicates whether the text was manually annotated by the developer.
- IntentsGrpcClient::GetIntent() — Method in class IntentsGrpcClient
- Retrieves the specified intent.
- ListContextsRequest::getParent() — Method in class ListContextsRequest
- Required. The session to list all contexts from.
- ListContextsRequest::getPageSize() — Method in class ListContextsRequest
- Optional. The maximum number of items to return in a single page. By default 100 and at most 1000.
- ListContextsRequest::getPageToken() — Method in class ListContextsRequest
- Optional. The next_page_token value returned from a previous list request.
- ListContextsResponse::getContexts() — Method in class ListContextsResponse
- The list of contexts. There will be a maximum number of items returned based on the page_size field in the request.
- ListContextsResponse::getNextPageToken() — Method in class ListContextsResponse
- Token to retrieve the next page of results, or empty if there are no more results in the list.
- ListEntityTypesRequest::getParent() — Method in class ListEntityTypesRequest
- Required. The agent to list all entity types from.
- ListEntityTypesRequest::getLanguageCode() — Method in class ListEntityTypesRequest
- Optional. The language to list entity synonyms for. If not specified, the agent's default language is used.
- ListEntityTypesRequest::getPageSize() — Method in class ListEntityTypesRequest
- Optional. The maximum number of items to return in a single page. By default 100 and at most 1000.
- ListEntityTypesRequest::getPageToken() — Method in class ListEntityTypesRequest
- Optional. The next_page_token value returned from a previous list request.
- ListEntityTypesResponse::getEntityTypes() — Method in class ListEntityTypesResponse
- The list of agent entity types. There will be a maximum number of items returned based on the page_size field in the request.
- ListEntityTypesResponse::getNextPageToken() — Method in class ListEntityTypesResponse
- Token to retrieve the next page of results, or empty if there are no more results in the list.
- ListIntentsRequest::getParent() — Method in class ListIntentsRequest
- Required. The agent to list all intents from.
- ListIntentsRequest::getLanguageCode() — Method in class ListIntentsRequest
- Optional. The language to list training phrases, parameters and rich messages for. If not specified, the agent's default language is used.
- ListIntentsRequest::getIntentView() — Method in class ListIntentsRequest
- Optional. The resource view to apply to the returned intent.
- ListIntentsRequest::getPageSize() — Method in class ListIntentsRequest
- Optional. The maximum number of items to return in a single page. By default 100 and at most 1000.
- ListIntentsRequest::getPageToken() — Method in class ListIntentsRequest
- Optional. The next_page_token value returned from a previous list request.
- ListIntentsResponse::getIntents() — Method in class ListIntentsResponse
- The list of agent intents. There will be a maximum number of items returned based on the page_size field in the request.
- ListIntentsResponse::getNextPageToken() — Method in class ListIntentsResponse
- Token to retrieve the next page of results, or empty if there are no more results in the list.
- ListSessionEntityTypesRequest::getParent() — Method in class ListSessionEntityTypesRequest
- Required. The session to list all session entity types from.
- ListSessionEntityTypesRequest::getPageSize() — Method in class ListSessionEntityTypesRequest
- Optional. The maximum number of items to return in a single page. By default 100 and at most 1000.
- ListSessionEntityTypesRequest::getPageToken() — Method in class ListSessionEntityTypesRequest
- Optional. The next_page_token value returned from a previous list request.
- ListSessionEntityTypesResponse::getSessionEntityTypes() — Method in class ListSessionEntityTypesResponse
- The list of session entity types. There will be a maximum number of items returned based on the page_size field in the request.
- ListSessionEntityTypesResponse::getNextPageToken() — Method in class ListSessionEntityTypesResponse
- Token to retrieve the next page of results, or empty if there are no more results in the list.
- OriginalDetectIntentRequest::getSource() — Method in class OriginalDetectIntentRequest
- The source of this request, e.g.,
google,facebook,slack. It is set by Dialogflow-owned servers. - OriginalDetectIntentRequest::getPayload() — Method in class OriginalDetectIntentRequest
- Optional. This field is set to the value of
QueryParameters.payloadfield passed in the request. - QueryInput::getAudioConfig() — Method in class QueryInput
- Instructs the speech recognizer how to process the speech audio.
- QueryInput::getText() — Method in class QueryInput
- The natural language text to be processed.
- QueryInput::getEvent() — Method in class QueryInput
- The event to be processed.
- QueryInput::getInput() — Method in class QueryInput
- QueryParameters::getTimeZone() — Method in class QueryParameters
- Optional. The time zone of this conversational query from the time zone database, e.g., America/New_York, Europe/Paris. If not provided, the time zone specified in agent settings is used.
- QueryParameters::getGeoLocation() — Method in class QueryParameters
- Optional. The geo location of this conversational query.
- QueryParameters::getContexts() — Method in class QueryParameters
- Optional. The collection of contexts to be activated before this query is executed.
- QueryParameters::getResetContexts() — Method in class QueryParameters
- Optional. Specifies whether to delete all contexts in the current session before the new ones are activated.
- QueryParameters::getSessionEntityTypes() — Method in class QueryParameters
- Optional. The collection of session entity types to replace or extend developer entities with for this query only. The entity synonyms apply to all languages.
- QueryParameters::getPayload() — Method in class QueryParameters
- Optional. This field can be used to pass custom data into the webhook associated with the agent. Arbitrary JSON objects are supported.
- QueryResult::getQueryText() — Method in class QueryResult
- The original conversational query text:
- If natural language text was provided as input,
query_textcontains a copy of the input. - QueryResult::getLanguageCode() — Method in class QueryResult
- The language that was triggered during intent detection.
- QueryResult::getSpeechRecognitionConfidence() — Method in class QueryResult
- The Speech recognition confidence between 0.0 and 1.0. A higher number indicates an estimated greater likelihood that the recognized words are correct. The default of 0.0 is a sentinel value indicating that confidence was not set.
- QueryResult::getAction() — Method in class QueryResult
- The action name from the matched intent.
- QueryResult::getParameters() — Method in class QueryResult
- The collection of extracted parameters.
- QueryResult::getAllRequiredParamsPresent() — Method in class QueryResult
- This field is set to:
-
falseif the matched intent has required parameters and not all of the required parameter values have been collected. - QueryResult::getFulfillmentText() — Method in class QueryResult
- The text to be pronounced to the user or shown on the screen.
- QueryResult::getFulfillmentMessages() — Method in class QueryResult
- The collection of rich messages to present to the user.
- QueryResult::getWebhookSource() — Method in class QueryResult
- If the query was fulfilled by a webhook call, this field is set to the
value of the
sourcefield returned in the webhook response. - QueryResult::getWebhookPayload() — Method in class QueryResult
- If the query was fulfilled by a webhook call, this field is set to the
value of the
payloadfield returned in the webhook response. - QueryResult::getOutputContexts() — Method in class QueryResult
- The collection of output contexts. If applicable,
output_contexts.parameterscontains entries with name<parameter name>.originalcontaining the original parameter values before the query. - QueryResult::getIntent() — Method in class QueryResult
- The intent that matched the conversational query. Some, not
all fields are filled in this message, including but not limited to:
name,display_nameandwebhook_state. - QueryResult::getIntentDetectionConfidence() — Method in class QueryResult
- The intent detection confidence. Values range from 0.0 (completely uncertain) to 1.0 (completely certain).
- QueryResult::getDiagnosticInfo() — Method in class QueryResult
- The free-form diagnostic info. For example, this field could contain webhook call latency.
- RestoreAgentRequest::getParent() — Method in class RestoreAgentRequest
- Required. The project that the agent to restore is associated with.
- RestoreAgentRequest::getAgentUri() — Method in class RestoreAgentRequest
- The URI to a Google Cloud Storage file containing the agent to restore.
- RestoreAgentRequest::getAgentContent() — Method in class RestoreAgentRequest
- The agent to restore.
- RestoreAgentRequest::getAgent() — Method in class RestoreAgentRequest
- SearchAgentsRequest::getParent() — Method in class SearchAgentsRequest
- Required. The project to list agents from.
- SearchAgentsRequest::getPageSize() — Method in class SearchAgentsRequest
- Optional. The maximum number of items to return in a single page. By default 100 and at most 1000.
- SearchAgentsRequest::getPageToken() — Method in class SearchAgentsRequest
- Optional. The next_page_token value returned from a previous list request.
- SearchAgentsResponse::getAgents() — Method in class SearchAgentsResponse
- The list of agents. There will be a maximum number of items returned based on the page_size field in the request.
- SearchAgentsResponse::getNextPageToken() — Method in class SearchAgentsResponse
- Token to retrieve the next page of results, or empty if there are no more results in the list.
- SessionEntityType::getName() — Method in class SessionEntityType
- Required. The unique identifier of this session entity type. Format:
projects/<Project ID>/agent/sessions/<Session ID>/entityTypes/<Entity Type Display Name>. - SessionEntityType::getEntityOverrideMode() — Method in class SessionEntityType
- Required. Indicates whether the additional data should override or supplement the developer entity type definition.
- SessionEntityType::getEntities() — Method in class SessionEntityType
- Required. The collection of entities associated with this session entity type.
- SessionEntityTypesGrpcClient::GetSessionEntityType() — Method in class SessionEntityTypesGrpcClient
- Retrieves the specified session entity type.
- StreamingDetectIntentRequest::getSession() — Method in class StreamingDetectIntentRequest
- Required. The name of the session the query is sent to.
- StreamingDetectIntentRequest::getQueryParams() — Method in class StreamingDetectIntentRequest
- Optional. The parameters of this query.
- StreamingDetectIntentRequest::getQueryInput() — Method in class StreamingDetectIntentRequest
- Required. The input specification. It can be set to: 1. an audio config which instructs the speech recognizer how to process the speech audio, 2. a conversational query in the form of text, or 3. an event that specifies which intent to trigger.
- StreamingDetectIntentRequest::getSingleUtterance() — Method in class StreamingDetectIntentRequest
- Optional. If
false(default), recognition does not cease until the client closes the stream. - StreamingDetectIntentRequest::getInputAudio() — Method in class StreamingDetectIntentRequest
- Optional. The input audio content to be recognized. Must be sent if
query_inputwas set to a streaming input audio config. The complete audio over all streaming messages must not exceed 1 minute. - StreamingDetectIntentResponse::getResponseId() — Method in class StreamingDetectIntentResponse
- The unique identifier of the response. It can be used to locate a response in the training example set or for reporting issues.
- StreamingDetectIntentResponse::getRecognitionResult() — Method in class StreamingDetectIntentResponse
- The result of speech recognition.
- StreamingDetectIntentResponse::getQueryResult() — Method in class StreamingDetectIntentResponse
- The result of the conversational query or event processing.
- StreamingDetectIntentResponse::getWebhookStatus() — Method in class StreamingDetectIntentResponse
- Specifies the status of the webhook request.
- StreamingRecognitionResult::getMessageType() — Method in class StreamingRecognitionResult
- Type of the result message.
- StreamingRecognitionResult::getTranscript() — Method in class StreamingRecognitionResult
- Transcript text representing the words that the user spoke.
- StreamingRecognitionResult::getIsFinal() — Method in class StreamingRecognitionResult
- The default of 0.0 is a sentinel value indicating
confidencewas not set. - StreamingRecognitionResult::getConfidence() — Method in class StreamingRecognitionResult
- The Speech confidence between 0.0 and 1.0 for the current portion of audio.
- TextInput::getText() — Method in class TextInput
- Required. The UTF-8 encoded natural language text to be processed.
- TextInput::getLanguageCode() — Method in class TextInput
- Required. The language of this conversational query. See Language Support for a list of the currently supported language codes. Note that queries in the same session do not necessarily need to specify the same language.
- TrainAgentRequest::getParent() — Method in class TrainAgentRequest
- Required. The project that the agent to train is associated with.
- UpdateContextRequest::getContext() — Method in class UpdateContextRequest
- Required. The context to update.
- UpdateContextRequest::getUpdateMask() — Method in class UpdateContextRequest
- Optional. The mask to control which fields get updated.
- UpdateEntityTypeRequest::getEntityType() — Method in class UpdateEntityTypeRequest
- Required. The entity type to update.
- UpdateEntityTypeRequest::getLanguageCode() — Method in class UpdateEntityTypeRequest
- Optional. The language of entity synonyms defined in
entity_type. If not specified, the agent's default language is used. - UpdateEntityTypeRequest::getUpdateMask() — Method in class UpdateEntityTypeRequest
- Optional. The mask to control which fields get updated.
- UpdateIntentRequest::getIntent() — Method in class UpdateIntentRequest
- Required. The intent to update.
- UpdateIntentRequest::getLanguageCode() — Method in class UpdateIntentRequest
- Optional. The language of training phrases, parameters and rich messages
defined in
intent. If not specified, the agent's default language is used. More than a dozen languages are supported. - UpdateIntentRequest::getUpdateMask() — Method in class UpdateIntentRequest
- Optional. The mask to control which fields get updated.
- UpdateIntentRequest::getIntentView() — Method in class UpdateIntentRequest
- Optional. The resource view to apply to the returned intent.
- UpdateSessionEntityTypeRequest::getSessionEntityType() — Method in class UpdateSessionEntityTypeRequest
- Required. The entity type to update. Format:
projects/<Project ID>/agent/sessions/<Session ID>/entityTypes/<Entity Type Display Name>. - UpdateSessionEntityTypeRequest::getUpdateMask() — Method in class UpdateSessionEntityTypeRequest
- Optional. The mask to control which fields get updated.
- WebhookRequest::getSession() — Method in class WebhookRequest
- The unique identifier of detectIntent request session.
- WebhookRequest::getResponseId() — Method in class WebhookRequest
- The unique identifier of the response. Contains the same value as
[Streaming]DetectIntentResponse.response_id. - WebhookRequest::getQueryResult() — Method in class WebhookRequest
- The result of the conversational query or event processing. Contains the
same value as
[Streaming]DetectIntentResponse.query_result. - WebhookRequest::getOriginalDetectIntentRequest() — Method in class WebhookRequest
- Optional. The contents of the original request that was passed to
[Streaming]DetectIntentcall. - WebhookResponse::getFulfillmentText() — Method in class WebhookResponse
- Optional. The text to be shown on the screen. This value is passed directly
to
QueryResult.fulfillment_text. - WebhookResponse::getFulfillmentMessages() — Method in class WebhookResponse
- Optional. The collection of rich messages to present to the user. This
value is passed directly to
QueryResult.fulfillment_messages. - WebhookResponse::getSource() — Method in class WebhookResponse
- Optional. This value is passed directly to
QueryResult.webhook_source. - WebhookResponse::getPayload() — Method in class WebhookResponse
- Optional. This value is passed directly to
QueryResult.webhook_payload. - WebhookResponse::getOutputContexts() — Method in class WebhookResponse
- Optional. The collection of output contexts. This value is passed directly
to
QueryResult.output_contexts. - WebhookResponse::getFollowupEventInput() — Method in class WebhookResponse
- Optional. Makes the platform immediately invoke another
DetectIntentcall internally with the specified event as input. - Action::getSaveFindings() — Method in class Action
- Save resulting findings in a provided location.
- Action::getPubSub() — Method in class Action
- Publish a notification to a pubsub topic.
- Action::getPublishSummaryToCscc() — Method in class Action
- Publish summary to Cloud Security Command Center (Alpha).
- Action::getAction() — Method in class Action
- Action_PublishToPubSub::getTopic() — Method in class Action_PublishToPubSub
- Cloud Pub/Sub topic to send notifications to. The topic must have given publishing access rights to the DLP API service account executing the long running DlpJob sending the notifications.
- Action_SaveFindings::getOutputConfig() — Method in class Action_SaveFindings
- Generated from protobuf field
.google.privacy.dlp.v2.OutputStorageConfig output_config = 1; - AnalyzeDataSourceRiskDetails::getRequestedPrivacyMetric() — Method in class AnalyzeDataSourceRiskDetails
- Privacy metric to compute.
- AnalyzeDataSourceRiskDetails::getRequestedSourceTable() — Method in class AnalyzeDataSourceRiskDetails
- Input dataset to compute metrics over.
- AnalyzeDataSourceRiskDetails::getNumericalStatsResult() — Method in class AnalyzeDataSourceRiskDetails
- Generated from protobuf field
.google.privacy.dlp.v2.AnalyzeDataSourceRiskDetails.NumericalStatsResult numerical_stats_result = 3; - AnalyzeDataSourceRiskDetails::getCategoricalStatsResult() — Method in class AnalyzeDataSourceRiskDetails
- Generated from protobuf field
.google.privacy.dlp.v2.AnalyzeDataSourceRiskDetails.CategoricalStatsResult categorical_stats_result = 4; - AnalyzeDataSourceRiskDetails::getKAnonymityResult() — Method in class AnalyzeDataSourceRiskDetails
- Generated from protobuf field
.google.privacy.dlp.v2.AnalyzeDataSourceRiskDetails.KAnonymityResult k_anonymity_result = 5; - AnalyzeDataSourceRiskDetails::getLDiversityResult() — Method in class AnalyzeDataSourceRiskDetails
- Generated from protobuf field
.google.privacy.dlp.v2.AnalyzeDataSourceRiskDetails.LDiversityResult l_diversity_result = 6; - AnalyzeDataSourceRiskDetails::getKMapEstimationResult() — Method in class AnalyzeDataSourceRiskDetails
- Generated from protobuf field
.google.privacy.dlp.v2.AnalyzeDataSourceRiskDetails.KMapEstimationResult k_map_estimation_result = 7; - AnalyzeDataSourceRiskDetails::getResult() — Method in class AnalyzeDataSourceRiskDetails
- AnalyzeDataSourceRiskDetails_CategoricalStatsResult::getValueFrequencyHistogramBuckets() — Method in class AnalyzeDataSourceRiskDetails_CategoricalStatsResult
- Histogram of value frequencies in the column.
- AnalyzeDataSourceRiskDetails_CategoricalStatsResult_CategoricalStatsHistogramBucket::getValueFrequencyLowerBound() — Method in class AnalyzeDataSourceRiskDetails_CategoricalStatsResult_CategoricalStatsHistogramBucket
- Lower bound on the value frequency of the values in this bucket.
- AnalyzeDataSourceRiskDetails_CategoricalStatsResult_CategoricalStatsHistogramBucket::getValueFrequencyUpperBound() — Method in class AnalyzeDataSourceRiskDetails_CategoricalStatsResult_CategoricalStatsHistogramBucket
- Upper bound on the value frequency of the values in this bucket.
- AnalyzeDataSourceRiskDetails_CategoricalStatsResult_CategoricalStatsHistogramBucket::getBucketSize() — Method in class AnalyzeDataSourceRiskDetails_CategoricalStatsResult_CategoricalStatsHistogramBucket
- Total number of values in this bucket.
- AnalyzeDataSourceRiskDetails_CategoricalStatsResult_CategoricalStatsHistogramBucket::getBucketValues() — Method in class AnalyzeDataSourceRiskDetails_CategoricalStatsResult_CategoricalStatsHistogramBucket
- Sample of value frequencies in this bucket. The total number of values returned per bucket is capped at 20.
- AnalyzeDataSourceRiskDetails_CategoricalStatsResult_CategoricalStatsHistogramBucket::getBucketValueCount() — Method in class AnalyzeDataSourceRiskDetails_CategoricalStatsResult_CategoricalStatsHistogramBucket
- Total number of distinct values in this bucket.
- AnalyzeDataSourceRiskDetails_KAnonymityResult::getEquivalenceClassHistogramBuckets() — Method in class AnalyzeDataSourceRiskDetails_KAnonymityResult
- Histogram of k-anonymity equivalence classes.
- AnalyzeDataSourceRiskDetails_KAnonymityResult_KAnonymityEquivalenceClass::getQuasiIdsValues() — Method in class AnalyzeDataSourceRiskDetails_KAnonymityResult_KAnonymityEquivalenceClass
- Set of values defining the equivalence class. One value per quasi-identifier column in the original KAnonymity metric message.
- AnalyzeDataSourceRiskDetails_KAnonymityResult_KAnonymityEquivalenceClass::getEquivalenceClassSize() — Method in class AnalyzeDataSourceRiskDetails_KAnonymityResult_KAnonymityEquivalenceClass
- Size of the equivalence class, for example number of rows with the above set of values.
- AnalyzeDataSourceRiskDetails_KAnonymityResult_KAnonymityHistogramBucket::getEquivalenceClassSizeLowerBound() — Method in class AnalyzeDataSourceRiskDetails_KAnonymityResult_KAnonymityHistogramBucket
- Lower bound on the size of the equivalence classes in this bucket.
- AnalyzeDataSourceRiskDetails_KAnonymityResult_KAnonymityHistogramBucket::getEquivalenceClassSizeUpperBound() — Method in class AnalyzeDataSourceRiskDetails_KAnonymityResult_KAnonymityHistogramBucket
- Upper bound on the size of the equivalence classes in this bucket.
- AnalyzeDataSourceRiskDetails_KAnonymityResult_KAnonymityHistogramBucket::getBucketSize() — Method in class AnalyzeDataSourceRiskDetails_KAnonymityResult_KAnonymityHistogramBucket
- Total number of equivalence classes in this bucket.
- AnalyzeDataSourceRiskDetails_KAnonymityResult_KAnonymityHistogramBucket::getBucketValues() — Method in class AnalyzeDataSourceRiskDetails_KAnonymityResult_KAnonymityHistogramBucket
- Sample of equivalence classes in this bucket. The total number of classes returned per bucket is capped at 20.
- AnalyzeDataSourceRiskDetails_KAnonymityResult_KAnonymityHistogramBucket::getBucketValueCount() — Method in class AnalyzeDataSourceRiskDetails_KAnonymityResult_KAnonymityHistogramBucket
- Total number of distinct equivalence classes in this bucket.
- AnalyzeDataSourceRiskDetails_KMapEstimationResult::getKMapEstimationHistogram() — Method in class AnalyzeDataSourceRiskDetails_KMapEstimationResult
- The intervals [min_anonymity, max_anonymity] do not overlap. If a value doesn't correspond to any such interval, the associated frequency is zero. For example, the following records: {min_anonymity: 1, max_anonymity: 1, frequency: 17} {min_anonymity: 2, max_anonymity: 3, frequency: 42} {min_anonymity: 5, max_anonymity: 10, frequency: 99} mean that there are no record with an estimated anonymity of 4, 5, or larger than 10.
- AnalyzeDataSourceRiskDetails_KMapEstimationResult_KMapEstimationHistogramBucket::getMinAnonymity() — Method in class AnalyzeDataSourceRiskDetails_KMapEstimationResult_KMapEstimationHistogramBucket
- Always positive.
- AnalyzeDataSourceRiskDetails_KMapEstimationResult_KMapEstimationHistogramBucket::getMaxAnonymity() — Method in class AnalyzeDataSourceRiskDetails_KMapEstimationResult_KMapEstimationHistogramBucket
- Always greater than or equal to min_anonymity.
- AnalyzeDataSourceRiskDetails_KMapEstimationResult_KMapEstimationHistogramBucket::getBucketSize() — Method in class AnalyzeDataSourceRiskDetails_KMapEstimationResult_KMapEstimationHistogramBucket
- Number of records within these anonymity bounds.
- AnalyzeDataSourceRiskDetails_KMapEstimationResult_KMapEstimationHistogramBucket::getBucketValues() — Method in class AnalyzeDataSourceRiskDetails_KMapEstimationResult_KMapEstimationHistogramBucket
- Sample of quasi-identifier tuple values in this bucket. The total number of classes returned per bucket is capped at 20.
- AnalyzeDataSourceRiskDetails_KMapEstimationResult_KMapEstimationHistogramBucket::getBucketValueCount() — Method in class AnalyzeDataSourceRiskDetails_KMapEstimationResult_KMapEstimationHistogramBucket
- Total number of distinct quasi-identifier tuple values in this bucket.
- AnalyzeDataSourceRiskDetails_KMapEstimationResult_KMapEstimationQuasiIdValues::getQuasiIdsValues() — Method in class AnalyzeDataSourceRiskDetails_KMapEstimationResult_KMapEstimationQuasiIdValues
- The quasi-identifier values.
- AnalyzeDataSourceRiskDetails_KMapEstimationResult_KMapEstimationQuasiIdValues::getEstimatedAnonymity() — Method in class AnalyzeDataSourceRiskDetails_KMapEstimationResult_KMapEstimationQuasiIdValues
- The estimated anonymity for these quasi-identifier values.
- AnalyzeDataSourceRiskDetails_LDiversityResult::getSensitiveValueFrequencyHistogramBuckets() — Method in class AnalyzeDataSourceRiskDetails_LDiversityResult
- Histogram of l-diversity equivalence class sensitive value frequencies.
- AnalyzeDataSourceRiskDetails_LDiversityResult_LDiversityEquivalenceClass::getQuasiIdsValues() — Method in class AnalyzeDataSourceRiskDetails_LDiversityResult_LDiversityEquivalenceClass
- Quasi-identifier values defining the k-anonymity equivalence class. The order is always the same as the original request.
- AnalyzeDataSourceRiskDetails_LDiversityResult_LDiversityEquivalenceClass::getEquivalenceClassSize() — Method in class AnalyzeDataSourceRiskDetails_LDiversityResult_LDiversityEquivalenceClass
- Size of the k-anonymity equivalence class.
- AnalyzeDataSourceRiskDetails_LDiversityResult_LDiversityEquivalenceClass::getNumDistinctSensitiveValues() — Method in class AnalyzeDataSourceRiskDetails_LDiversityResult_LDiversityEquivalenceClass
- Number of distinct sensitive values in this equivalence class.
- AnalyzeDataSourceRiskDetails_LDiversityResult_LDiversityEquivalenceClass::getTopSensitiveValues() — Method in class AnalyzeDataSourceRiskDetails_LDiversityResult_LDiversityEquivalenceClass
- Estimated frequencies of top sensitive values.
- AnalyzeDataSourceRiskDetails_LDiversityResult_LDiversityHistogramBucket::getSensitiveValueFrequencyLowerBound() — Method in class AnalyzeDataSourceRiskDetails_LDiversityResult_LDiversityHistogramBucket
- Lower bound on the sensitive value frequencies of the equivalence classes in this bucket.
- AnalyzeDataSourceRiskDetails_LDiversityResult_LDiversityHistogramBucket::getSensitiveValueFrequencyUpperBound() — Method in class AnalyzeDataSourceRiskDetails_LDiversityResult_LDiversityHistogramBucket
- Upper bound on the sensitive value frequencies of the equivalence classes in this bucket.
- AnalyzeDataSourceRiskDetails_LDiversityResult_LDiversityHistogramBucket::getBucketSize() — Method in class AnalyzeDataSourceRiskDetails_LDiversityResult_LDiversityHistogramBucket
- Total number of equivalence classes in this bucket.
- AnalyzeDataSourceRiskDetails_LDiversityResult_LDiversityHistogramBucket::getBucketValues() — Method in class AnalyzeDataSourceRiskDetails_LDiversityResult_LDiversityHistogramBucket
- Sample of equivalence classes in this bucket. The total number of classes returned per bucket is capped at 20.
- AnalyzeDataSourceRiskDetails_LDiversityResult_LDiversityHistogramBucket::getBucketValueCount() — Method in class AnalyzeDataSourceRiskDetails_LDiversityResult_LDiversityHistogramBucket
- Total number of distinct equivalence classes in this bucket.
- AnalyzeDataSourceRiskDetails_NumericalStatsResult::getMinValue() — Method in class AnalyzeDataSourceRiskDetails_NumericalStatsResult
- Minimum value appearing in the column.
- AnalyzeDataSourceRiskDetails_NumericalStatsResult::getMaxValue() — Method in class AnalyzeDataSourceRiskDetails_NumericalStatsResult
- Maximum value appearing in the column.
- AnalyzeDataSourceRiskDetails_NumericalStatsResult::getQuantileValues() — Method in class AnalyzeDataSourceRiskDetails_NumericalStatsResult
- List of 99 values that partition the set of field values into 100 equal sized buckets.
- BigQueryKey::getTableReference() — Method in class BigQueryKey
- Complete BigQuery table reference.
- BigQueryKey::getRowNumber() — Method in class BigQueryKey
- Absolute number of the row from the beginning of the table at the time of scanning.
- BigQueryOptions::getTableReference() — Method in class BigQueryOptions
- Complete BigQuery table reference.
- BigQueryOptions::getIdentifyingFields() — Method in class BigQueryOptions
- References to fields uniquely identifying rows within the table.
- BigQueryOptions::getRowsLimit() — Method in class BigQueryOptions
- Max number of rows to scan. If the table has more rows than this value, the rest of the rows are omitted. If not set, or if set to 0, all rows will be scanned. Cannot be used in conjunction with TimespanConfig.
- BigQueryOptions::getSampleMethod() — Method in class BigQueryOptions
- Generated from protobuf field
.google.privacy.dlp.v2.BigQueryOptions.SampleMethod sample_method = 4; - BigQueryTable::getProjectId() — Method in class BigQueryTable
- The Google Cloud Platform project ID of the project containing the table.
- BigQueryTable::getDatasetId() — Method in class BigQueryTable
- Dataset ID of the table.
- BigQueryTable::getTableId() — Method in class BigQueryTable
- Name of the table.
- BoundingBox::getTop() — Method in class BoundingBox
- Top coordinate of the bounding box. (0,0) is upper left.
- BoundingBox::getLeft() — Method in class BoundingBox
- Left coordinate of the bounding box. (0,0) is upper left.
- BoundingBox::getWidth() — Method in class BoundingBox
- Width of the bounding box in pixels.
- BoundingBox::getHeight() — Method in class BoundingBox
- Height of the bounding box in pixels.
- BucketingConfig::getBuckets() — Method in class BucketingConfig
- Set of buckets. Ranges must be non-overlapping.
- BucketingConfig_Bucket::getMin() — Method in class BucketingConfig_Bucket
- Lower bound of the range, inclusive. Type should be the same as max if used.
- BucketingConfig_Bucket::getMax() — Method in class BucketingConfig_Bucket
- Upper bound of the range, exclusive; type must match min.
- BucketingConfig_Bucket::getReplacementValue() — Method in class BucketingConfig_Bucket
- Replacement value for this bucket. If not provided the default behavior will be to hyphenate the min-max range.
- ByteContentItem::getType() — Method in class ByteContentItem
- The type of data stored in the bytes string. Default will be TEXT_UTF8.
- ByteContentItem::getData() — Method in class ByteContentItem
- Content data to inspect or redact.
- CancelDlpJobRequest::getName() — Method in class CancelDlpJobRequest
- The name of the DlpJob resource to be cancelled.
- CharacterMaskConfig::getMaskingCharacter() — Method in class CharacterMaskConfig
- Character to mask the sensitive values—for example, "" for an alphabetic string such as name, or "0" for a numeric string such as ZIP code or credit card number. String must have length 1. If not supplied, we will default to "" for strings, 0 for digits.
- CharacterMaskConfig::getNumberToMask() — Method in class CharacterMaskConfig
- Number of characters to mask. If not set, all matching chars will be masked. Skipped characters do not count towards this tally.
- CharacterMaskConfig::getReverseOrder() — Method in class CharacterMaskConfig
- Mask characters in reverse order. For example, if
masking_characteris '0', number_to_mask is 14, andreverse_orderis false, then 1234-5678-9012-3456 -> 00000000000000-3456 Ifmasking_characteris '*',number_to_maskis 3, andreverse_orderis true, then 12345 -> 12*** - CharacterMaskConfig::getCharactersToIgnore() — Method in class CharacterMaskConfig
- When masking a string, items in this list will be skipped when replacing.
- CharsToIgnore::getCharactersToSkip() — Method in class CharsToIgnore
- Generated from protobuf field
string characters_to_skip = 1; - CharsToIgnore::getCommonCharactersToIgnore() — Method in class CharsToIgnore
- Generated from protobuf field
.google.privacy.dlp.v2.CharsToIgnore.CommonCharsToIgnore common_characters_to_ignore = 2; - CharsToIgnore::getCharacters() — Method in class CharsToIgnore
- CloudStorageOptions::getFileSet() — Method in class CloudStorageOptions
- Generated from protobuf field
.google.privacy.dlp.v2.CloudStorageOptions.FileSet file_set = 1; - CloudStorageOptions::getBytesLimitPerFile() — Method in class CloudStorageOptions
- Max number of bytes to scan from a file. If a scanned file's size is bigger than this value then the rest of the bytes are omitted.
- CloudStorageOptions::getFileTypes() — Method in class CloudStorageOptions
- List of file type groups to include in the scan.
- CloudStorageOptions::getSampleMethod() — Method in class CloudStorageOptions
- Generated from protobuf field
.google.privacy.dlp.v2.CloudStorageOptions.SampleMethod sample_method = 6; - CloudStorageOptions::getFilesLimitPercent() — Method in class CloudStorageOptions
- Limits the number of files to scan to this percentage of the input FileSet.
- CloudStorageOptions_FileSet::getUrl() — Method in class CloudStorageOptions_FileSet
- The url, in the format
gs://<bucket>/<path>. Trailing wildcard in the path is allowed. - CloudStoragePath::getPath() — Method in class CloudStoragePath
- A url representing a file or path (no wildcards) in Cloud Storage.
- Color::getRed() — Method in class Color
- The amount of red in the color as a value in the interval [0, 1].
- Color::getGreen() — Method in class Color
- The amount of green in the color as a value in the interval [0, 1].
- Color::getBlue() — Method in class Color
- The amount of blue in the color as a value in the interval [0, 1].
- ContentItem::getValue() — Method in class ContentItem
- String data to inspect or redact.
- ContentItem::getTable() — Method in class ContentItem
- Structured content for inspection.
- ContentItem::getByteItem() — Method in class ContentItem
- Content data to inspect or redact. Replaces
typeanddata. - ContentItem::getDataItem() — Method in class ContentItem
- ContentLocation::getContainerName() — Method in class ContentLocation
- Name of the container where the finding is located.
- ContentLocation::getRecordLocation() — Method in class ContentLocation
- Location within a row or record of a database table.
- ContentLocation::getImageLocation() — Method in class ContentLocation
- Location within an image's pixels.
- ContentLocation::getDocumentLocation() — Method in class ContentLocation
- Location data for document files.
- ContentLocation::getContainerTimestamp() — Method in class ContentLocation
- Findings container modification timestamp, if applicable.
- ContentLocation::getContainerVersion() — Method in class ContentLocation
- Findings container version, if available ("generation" for Google Cloud Storage).
- ContentLocation::getLocation() — Method in class ContentLocation
- CreateDeidentifyTemplateRequest::getParent() — Method in class CreateDeidentifyTemplateRequest
- The parent resource name, for example projects/my-project-id or organizations/my-org-id.
- CreateDeidentifyTemplateRequest::getDeidentifyTemplate() — Method in class CreateDeidentifyTemplateRequest
- The DeidentifyTemplate to create.
- CreateDeidentifyTemplateRequest::getTemplateId() — Method in class CreateDeidentifyTemplateRequest
- The template id can contain uppercase and lowercase letters,
numbers, and hyphens; that is, it must match the regular
expression:
[a-zA-Z\\d-]+. The maximum length is 100 characters. Can be empty to allow the system to generate one. - CreateDlpJobRequest::getParent() — Method in class CreateDlpJobRequest
- The parent resource name, for example projects/my-project-id.
- CreateDlpJobRequest::getInspectJob() — Method in class CreateDlpJobRequest
- Generated from protobuf field
.google.privacy.dlp.v2.InspectJobConfig inspect_job = 2; - CreateDlpJobRequest::getRiskJob() — Method in class CreateDlpJobRequest
- Generated from protobuf field
.google.privacy.dlp.v2.RiskAnalysisJobConfig risk_job = 3; - CreateDlpJobRequest::getJobId() — Method in class CreateDlpJobRequest
- The job id can contain uppercase and lowercase letters,
numbers, and hyphens; that is, it must match the regular
expression:
[a-zA-Z\\d-]+. The maximum length is 100 characters. Can be empty to allow the system to generate one. - CreateDlpJobRequest::getJob() — Method in class CreateDlpJobRequest
- CreateInspectTemplateRequest::getParent() — Method in class CreateInspectTemplateRequest
- The parent resource name, for example projects/my-project-id or organizations/my-org-id.
- CreateInspectTemplateRequest::getInspectTemplate() — Method in class CreateInspectTemplateRequest
- The InspectTemplate to create.
- CreateInspectTemplateRequest::getTemplateId() — Method in class CreateInspectTemplateRequest
- The template id can contain uppercase and lowercase letters,
numbers, and hyphens; that is, it must match the regular
expression:
[a-zA-Z\\d-]+. The maximum length is 100 characters. Can be empty to allow the system to generate one. - CreateJobTriggerRequest::getParent() — Method in class CreateJobTriggerRequest
- The parent resource name, for example projects/my-project-id.
- CreateJobTriggerRequest::getJobTrigger() — Method in class CreateJobTriggerRequest
- The JobTrigger to create.
- CreateJobTriggerRequest::getTriggerId() — Method in class CreateJobTriggerRequest
- The trigger id can contain uppercase and lowercase letters,
numbers, and hyphens; that is, it must match the regular
expression:
[a-zA-Z\\d-]+. The maximum length is 100 characters. Can be empty to allow the system to generate one. - CryptoHashConfig::getCryptoKey() — Method in class CryptoHashConfig
- The key used by the hash function.
- CryptoKey::getTransient() — Method in class CryptoKey
- Generated from protobuf field
.google.privacy.dlp.v2.TransientCryptoKey transient = 1; - CryptoKey::getUnwrapped() — Method in class CryptoKey
- Generated from protobuf field
.google.privacy.dlp.v2.UnwrappedCryptoKey unwrapped = 2; - CryptoKey::getKmsWrapped() — Method in class CryptoKey
- Generated from protobuf field
.google.privacy.dlp.v2.KmsWrappedCryptoKey kms_wrapped = 3; - CryptoKey::getSource() — Method in class CryptoKey
- CryptoReplaceFfxFpeConfig::getCryptoKey() — Method in class CryptoReplaceFfxFpeConfig
- The key used by the encryption algorithm. [required]
- CryptoReplaceFfxFpeConfig::getContext() — Method in class CryptoReplaceFfxFpeConfig
- The 'tweak', a context may be used for higher security since the same identifier in two different contexts won't be given the same surrogate. If the context is not set, a default tweak will be used.
- CryptoReplaceFfxFpeConfig::getCommonAlphabet() — Method in class CryptoReplaceFfxFpeConfig
- Generated from protobuf field
.google.privacy.dlp.v2.CryptoReplaceFfxFpeConfig.FfxCommonNativeAlphabet common_alphabet = 4; - CryptoReplaceFfxFpeConfig::getCustomAlphabet() — Method in class CryptoReplaceFfxFpeConfig
- This is supported by mapping these to the alphanumeric characters that the FFX mode natively supports. This happens before/after encryption/decryption.
- CryptoReplaceFfxFpeConfig::getRadix() — Method in class CryptoReplaceFfxFpeConfig
- The native way to select the alphabet. Must be in the range [2, 62].
- CryptoReplaceFfxFpeConfig::getSurrogateInfoType() — Method in class CryptoReplaceFfxFpeConfig
- The custom infoType to annotate the surrogate with.
- CryptoReplaceFfxFpeConfig::getAlphabet() — Method in class CryptoReplaceFfxFpeConfig
- CustomInfoType::getInfoType() — Method in class CustomInfoType
- Info type configuration. All custom info types must have configurations that do not conflict with built-in info types or other custom info types.
- CustomInfoType::getLikelihood() — Method in class CustomInfoType
- Likelihood to return for this custom info type. This base value can be
altered by a detection rule if the finding meets the criteria specified by
the rule. Defaults to
VERY_LIKELYif not specified. - CustomInfoType::getDictionary() — Method in class CustomInfoType
- Dictionary-based custom info type.
- CustomInfoType::getRegex() — Method in class CustomInfoType
- Regex-based custom info type.
- CustomInfoType::getSurrogateType() — Method in class CustomInfoType
- Surrogate info type.
- CustomInfoType::getDetectionRules() — Method in class CustomInfoType
- Set of detection rules to apply to all findings of this custom info type.
- CustomInfoType::getType() — Method in class CustomInfoType
- CustomInfoType_DetectionRule::getHotwordRule() — Method in class CustomInfoType_DetectionRule
- Hotword-based detection rule.
- CustomInfoType_DetectionRule::getType() — Method in class CustomInfoType_DetectionRule
- CustomInfoType_DetectionRule_HotwordRule::getHotwordRegex() — Method in class CustomInfoType_DetectionRule_HotwordRule
- Regex pattern defining what qualifies as a hotword.
- CustomInfoType_DetectionRule_HotwordRule::getProximity() — Method in class CustomInfoType_DetectionRule_HotwordRule
- Proximity of the finding within which the entire hotword must reside.
- CustomInfoType_DetectionRule_HotwordRule::getLikelihoodAdjustment() — Method in class CustomInfoType_DetectionRule_HotwordRule
- Likelihood adjustment to apply to all matching findings.
- CustomInfoType_DetectionRule_LikelihoodAdjustment::getFixedLikelihood() — Method in class CustomInfoType_DetectionRule_LikelihoodAdjustment
- Set the likelihood of a finding to a fixed value.
- CustomInfoType_DetectionRule_LikelihoodAdjustment::getRelativeLikelihood() — Method in class CustomInfoType_DetectionRule_LikelihoodAdjustment
- Increase or decrease the likelihood by the specified number of
levels. For example, if a finding would be
POSSIBLEwithout the detection rule andrelative_likelihoodis 1, then it is upgraded toLIKELY, while a value of -1 would downgrade it toUNLIKELY. - CustomInfoType_DetectionRule_LikelihoodAdjustment::getAdjustment() — Method in class CustomInfoType_DetectionRule_LikelihoodAdjustment
- CustomInfoType_DetectionRule_Proximity::getWindowBefore() — Method in class CustomInfoType_DetectionRule_Proximity
- Number of characters before the finding to consider.
- CustomInfoType_DetectionRule_Proximity::getWindowAfter() — Method in class CustomInfoType_DetectionRule_Proximity
- Number of characters after the finding to consider.
- CustomInfoType_Dictionary::getWordList() — Method in class CustomInfoType_Dictionary
- List of words or phrases to search for.
- CustomInfoType_Dictionary::getCloudStoragePath() — Method in class CustomInfoType_Dictionary
- Newline-delimited file of words in Cloud Storage. Only a single file is accepted.
- CustomInfoType_Dictionary::getSource() — Method in class CustomInfoType_Dictionary
- CustomInfoType_Dictionary_WordList::getWords() — Method in class CustomInfoType_Dictionary_WordList
- Words or phrases defining the dictionary. The dictionary must contain at least one phrase and every phrase must contain at least 2 characters that are letters or digits. [required]
- CustomInfoType_Regex::getPattern() — Method in class CustomInfoType_Regex
- Pattern defining the regular expression.
- DatastoreKey::getEntityKey() — Method in class DatastoreKey
- Datastore entity key.
- DatastoreOptions::getPartitionId() — Method in class DatastoreOptions
- A partition ID identifies a grouping of entities. The grouping is always by project and namespace, however the namespace ID may be empty.
- DatastoreOptions::getKind() — Method in class DatastoreOptions
- The kind to process.
- DateShiftConfig::getUpperBoundDays() — Method in class DateShiftConfig
- Range of shift in days. Actual shift will be selected at random within this range (inclusive ends). Negative means shift to earlier in time. Must not be more than 365250 days (1000 years) each direction.
- DateShiftConfig::getLowerBoundDays() — Method in class DateShiftConfig
- For example, -5 means shift date to at most 5 days back in the past.
- DateShiftConfig::getContext() — Method in class DateShiftConfig
- Points to the field that contains the context, for example, an entity id.
- DateShiftConfig::getCryptoKey() — Method in class DateShiftConfig
- Causes the shift to be computed based on this key and the context. This results in the same shift for the same context and crypto_key.
- DateShiftConfig::getMethod() — Method in class DateShiftConfig
- DateTime::getDate() — Method in class DateTime
- One or more of the following must be set. All fields are optional, but when set must be valid date or time values.
- DateTime::getDayOfWeek() — Method in class DateTime
- Generated from protobuf field
.google.type.DayOfWeek day_of_week = 2; - DateTime::getTime() — Method in class DateTime
- Generated from protobuf field
.google.type.TimeOfDay time = 3; - DateTime::getTimeZone() — Method in class DateTime
- Generated from protobuf field
.google.privacy.dlp.v2.DateTime.TimeZone time_zone = 4; - DateTime_TimeZone::getOffsetMinutes() — Method in class DateTime_TimeZone
- Set only if the offset can be determined. Positive for time ahead of UTC.
- DeidentifyConfig::getInfoTypeTransformations() — Method in class DeidentifyConfig
- Treat the dataset as free-form text and apply the same free text transformation everywhere.
- DeidentifyConfig::getRecordTransformations() — Method in class DeidentifyConfig
- Treat the dataset as structured. Transformations can be applied to specific locations within structured datasets, such as transforming a column within a table.
- DeidentifyConfig::getTransformation() — Method in class DeidentifyConfig
- DeidentifyContentRequest::getParent() — Method in class DeidentifyContentRequest
- The parent resource name, for example projects/my-project-id.
- DeidentifyContentRequest::getDeidentifyConfig() — Method in class DeidentifyContentRequest
- Configuration for the de-identification of the content item.
- DeidentifyContentRequest::getInspectConfig() — Method in class DeidentifyContentRequest
- Configuration for the inspector.
- DeidentifyContentRequest::getItem() — Method in class DeidentifyContentRequest
- The item to de-identify. Will be treated as text.
- DeidentifyContentRequest::getInspectTemplateName() — Method in class DeidentifyContentRequest
- Optional template to use. Any configuration directly specified in inspect_config will override those set in the template. Singular fields that are set in this request will replace their corresponding fields in the template. Repeated fields are appended. Singular sub-messages and groups are recursively merged.
- DeidentifyContentRequest::getDeidentifyTemplateName() — Method in class DeidentifyContentRequest
- Optional template to use. Any configuration directly specified in deidentify_config will override those set in the template. Singular fields that are set in this request will replace their corresponding fields in the template. Repeated fields are appended. Singular sub-messages and groups are recursively merged.
- DeidentifyContentResponse::getItem() — Method in class DeidentifyContentResponse
- The de-identified item.
- DeidentifyContentResponse::getOverview() — Method in class DeidentifyContentResponse
- An overview of the changes that were made on the
item. - DeidentifyTemplate::getName() — Method in class DeidentifyTemplate
- The template name. Output only.
- DeidentifyTemplate::getDisplayName() — Method in class DeidentifyTemplate
- Display name (max 256 chars).
- DeidentifyTemplate::getDescription() — Method in class DeidentifyTemplate
- Short description (max 256 chars).
- DeidentifyTemplate::getCreateTime() — Method in class DeidentifyTemplate
- The creation timestamp of a inspectTemplate, output only field.
- DeidentifyTemplate::getUpdateTime() — Method in class DeidentifyTemplate
- The last update timestamp of a inspectTemplate, output only field.
- DeidentifyTemplate::getDeidentifyConfig() — Method in class DeidentifyTemplate
- ///////////// // The core content of the template // ///////////////
- DeleteDeidentifyTemplateRequest::getName() — Method in class DeleteDeidentifyTemplateRequest
- Resource name of the organization and deidentify template to be deleted,
for example
organizations/433245324/deidentifyTemplates/432452342or projects/project-id/deidentifyTemplates/432452342. - DeleteDlpJobRequest::getName() — Method in class DeleteDlpJobRequest
- The name of the DlpJob resource to be deleted.
- DeleteInspectTemplateRequest::getName() — Method in class DeleteInspectTemplateRequest
- Resource name of the organization and inspectTemplate to be deleted, for
example
organizations/433245324/inspectTemplates/432452342or projects/project-id/inspectTemplates/432452342. - DeleteJobTriggerRequest::getName() — Method in class DeleteJobTriggerRequest
- Resource name of the project and the triggeredJob, for example
projects/dlp-test-project/jobTriggers/53234423. - DlpJob::getName() — Method in class DlpJob
- The server-assigned name.
- DlpJob::getType() — Method in class DlpJob
- The type of job.
- DlpJob::getState() — Method in class DlpJob
- State of a job.
- DlpJob::getRiskDetails() — Method in class DlpJob
- Results from analyzing risk of a data source.
- DlpJob::getInspectDetails() — Method in class DlpJob
- Results from inspecting a data source.
- DlpJob::getCreateTime() — Method in class DlpJob
- Time when the job was created.
- DlpJob::getStartTime() — Method in class DlpJob
- Time when the job started.
- DlpJob::getEndTime() — Method in class DlpJob
- Time when the job finished.
- DlpJob::getJobTriggerName() — Method in class DlpJob
- If created by a job trigger, the resource name of the trigger that instantiated the job.
- DlpJob::getErrors() — Method in class DlpJob
- A stream of errors encountered running the job.
- DlpJob::getDetails() — Method in class DlpJob
- DlpServiceGrpcClient::GetInspectTemplate() — Method in class DlpServiceGrpcClient
- Gets an InspectTemplate.
- DlpServiceGrpcClient::GetDeidentifyTemplate() — Method in class DlpServiceGrpcClient
- Gets a DeidentifyTemplate.
- DlpServiceGrpcClient::GetJobTrigger() — Method in class DlpServiceGrpcClient
- Gets a job trigger.
- DlpServiceGrpcClient::GetDlpJob() — Method in class DlpServiceGrpcClient
- Gets the latest state of a long-running DlpJob.
- DocumentLocation::getFileOffset() — Method in class DocumentLocation
- Offset of the line, from the beginning of the file, where the finding is located.
- EntityId::getField() — Method in class EntityId
- Composite key indicating which field contains the entity identifier.
- Error::getDetails() — Method in class Error
- Generated from protobuf field
.google.rpc.Status details = 1; - Error::getTimestamps() — Method in class Error
- The times the error occurred.
- FieldId::getName() — Method in class FieldId
- Name describing the field.
- FieldTransformation::getFields() — Method in class FieldTransformation
- Input field(s) to apply the transformation to. [required]
- FieldTransformation::getCondition() — Method in class FieldTransformation
- Only apply the transformation if the condition evaluates to true for the
given
RecordCondition. The conditions are allowed to reference fields that are not used in the actual transformation. [optional] Example Use Cases: - Apply a different bucket transformation to an age column if the zip code column for the same record is within a specific range. - FieldTransformation::getPrimitiveTransformation() — Method in class FieldTransformation
- Apply the transformation to the entire field.
- FieldTransformation::getInfoTypeTransformations() — Method in class FieldTransformation
- Treat the contents of the field as free text, and selectively
transform content that matches an
InfoType. - FieldTransformation::getTransformation() — Method in class FieldTransformation
- Finding::getQuote() — Method in class Finding
- The content that was found. Even if the content is not textual, it may be converted to a textual representation here.
- Finding::getInfoType() — Method in class Finding
- The type of content that might have been found.
- Finding::getLikelihood() — Method in class Finding
- Estimate of how likely it is that the
info_typeis correct. - Finding::getLocation() — Method in class Finding
- Where the content was found.
- Finding::getCreateTime() — Method in class Finding
- Timestamp when finding was detected.
- Finding::getQuoteInfo() — Method in class Finding
- Contains data parsed from quotes. Only populated if include_quote was set to true and a supported infoType was requested. Currently supported infoTypes: DATE, DATE_OF_BIRTH and TIME.
- FixedSizeBucketingConfig::getLowerBound() — Method in class FixedSizeBucketingConfig
- Lower bound value of buckets. All values less than
lower_boundare grouped together into a single bucket; for example iflower_bound= 10, then all values less than 10 are replaced with the value “-10”. [Required]. - FixedSizeBucketingConfig::getUpperBound() — Method in class FixedSizeBucketingConfig
- Upper bound value of buckets. All values greater than upper_bound are
grouped together into a single bucket; for example if
upper_bound= 89, then all values greater than 89 are replaced with the value “89+”. - FixedSizeBucketingConfig::getBucketSize() — Method in class FixedSizeBucketingConfig
- Size of each bucket (except for minimum and maximum buckets). So if
lower_bound= 10,upper_bound= 89, andbucket_size= 10, then the following buckets would be used: -10, 10-20, 20-30, 30-40, 40-50, 50-60, 60-70, 70-80, 80-89, 89+. Precision up to 2 decimals works. [Required]. - GetDeidentifyTemplateRequest — Class in namespace Google\Cloud\Dlp\V2
- Request message for GetDeidentifyTemplate.
- GetDeidentifyTemplateRequest::getName() — Method in class GetDeidentifyTemplateRequest
- Resource name of the organization and deidentify template to be read, for
example
organizations/433245324/deidentifyTemplates/432452342or projects/project-id/deidentifyTemplates/432452342. - GetDlpJobRequest — Class in namespace Google\Cloud\Dlp\V2
- The request message for [DlpJobs.GetDlpJob][].
- GetDlpJobRequest::getName() — Method in class GetDlpJobRequest
- The name of the DlpJob resource.
- GetInspectTemplateRequest — Class in namespace Google\Cloud\Dlp\V2
- Request message for GetInspectTemplate.
- GetInspectTemplateRequest::getName() — Method in class GetInspectTemplateRequest
- Resource name of the organization and inspectTemplate to be read, for
example
organizations/433245324/inspectTemplates/432452342or projects/project-id/inspectTemplates/432452342. - GetJobTriggerRequest — Class in namespace Google\Cloud\Dlp\V2
- Request message for GetJobTrigger.
- GetJobTriggerRequest::getName() — Method in class GetJobTriggerRequest
- Resource name of the project and the triggeredJob, for example
projects/dlp-test-project/jobTriggers/53234423. - ImageLocation::getBoundingBoxes() — Method in class ImageLocation
- Bounding boxes locating the pixels within the image containing the finding.
- InfoType::getName() — Method in class InfoType
- Name of the information type.
- InfoTypeDescription::getName() — Method in class InfoTypeDescription
- Internal name of the infoType.
- InfoTypeDescription::getDisplayName() — Method in class InfoTypeDescription
- Human readable form of the infoType name.
- InfoTypeDescription::getSupportedBy() — Method in class InfoTypeDescription
- Which parts of the API supports this InfoType.
- InfoTypeStats::getInfoType() — Method in class InfoTypeStats
- The type of finding this stat is for.
- InfoTypeStats::getCount() — Method in class InfoTypeStats
- Number of findings for this infoType.
- InfoTypeTransformations::getTransformations() — Method in class InfoTypeTransformations
- Transformation for each infoType. Cannot specify more than one for a given infoType. [required]
- InfoTypeTransformations_InfoTypeTransformation::getInfoTypes() — Method in class InfoTypeTransformations_InfoTypeTransformation
- InfoTypes to apply the transformation to. Empty list will match all available infoTypes for this transformation.
- InfoTypeTransformations_InfoTypeTransformation::getPrimitiveTransformation() — Method in class InfoTypeTransformations_InfoTypeTransformation
- Primitive transformation to apply to the infoType. [required]
- InspectConfig::getInfoTypes() — Method in class InspectConfig
- Restricts what info_types to look for. The values must correspond to InfoType values returned by ListInfoTypes or found in documentation.
- InspectConfig::getMinLikelihood() — Method in class InspectConfig
- Only returns findings equal or above this threshold. The default is POSSIBLE.
- InspectConfig::getLimits() — Method in class InspectConfig
- Generated from protobuf field
.google.privacy.dlp.v2.InspectConfig.FindingLimits limits = 3; - InspectConfig::getIncludeQuote() — Method in class InspectConfig
- When true, a contextual quote from the data that triggered a finding is included in the response; see Finding.quote.
- InspectConfig::getExcludeInfoTypes() — Method in class InspectConfig
- When true, excludes type information of the findings.
- InspectConfig::getCustomInfoTypes() — Method in class InspectConfig
- Custom infoTypes provided by the user.
- InspectConfig::getContentOptions() — Method in class InspectConfig
- List of options defining data content to scan.
- InspectConfig_FindingLimits::getMaxFindingsPerItem() — Method in class InspectConfig_FindingLimits
- Max number of findings that will be returned for each item scanned.
- InspectConfig_FindingLimits::getMaxFindingsPerRequest() — Method in class InspectConfig_FindingLimits
- Max number of findings that will be returned per request/job.
- InspectConfig_FindingLimits::getMaxFindingsPerInfoType() — Method in class InspectConfig_FindingLimits
- Configuration of findings limit given for specified infoTypes.
- InspectConfig_FindingLimits_InfoTypeLimit::getInfoType() — Method in class InspectConfig_FindingLimits_InfoTypeLimit
- Type of information the findings limit applies to. Only one limit per info_type should be provided. If InfoTypeLimit does not have an info_type, the DLP API applies the limit against all info_types that are found but not specified in another InfoTypeLimit.
- InspectConfig_FindingLimits_InfoTypeLimit::getMaxFindings() — Method in class InspectConfig_FindingLimits_InfoTypeLimit
- Max findings limit for the given infoType.
- InspectContentRequest::getParent() — Method in class InspectContentRequest
- The parent resource name, for example projects/my-project-id.
- InspectContentRequest::getInspectConfig() — Method in class InspectContentRequest
- Configuration for the inspector. What specified here will override the template referenced by the inspect_template_name argument.
- InspectContentRequest::getItem() — Method in class InspectContentRequest
- The item to inspect.
- InspectContentRequest::getInspectTemplateName() — Method in class InspectContentRequest
- Optional template to use. Any configuration directly specified in inspect_config will override those set in the template. Singular fields that are set in this request will replace their corresponding fields in the template. Repeated fields are appended. Singular sub-messages and groups are recursively merged.
- InspectContentResponse::getResult() — Method in class InspectContentResponse
- The findings.
- InspectDataSourceDetails::getRequestedOptions() — Method in class InspectDataSourceDetails
- The configuration used for this job.
- InspectDataSourceDetails::getResult() — Method in class InspectDataSourceDetails
- A summary of the outcome of this inspect job.
- InspectDataSourceDetails_RequestedOptions::getSnapshotInspectTemplate() — Method in class InspectDataSourceDetails_RequestedOptions
- If run with an InspectTemplate, a snapshot of its state at the time of this run.
- InspectDataSourceDetails_RequestedOptions::getJobConfig() — Method in class InspectDataSourceDetails_RequestedOptions
- Generated from protobuf field
.google.privacy.dlp.v2.InspectJobConfig job_config = 3; - InspectDataSourceDetails_Result::getProcessedBytes() — Method in class InspectDataSourceDetails_Result
- Total size in bytes that were processed.
- InspectDataSourceDetails_Result::getTotalEstimatedBytes() — Method in class InspectDataSourceDetails_Result
- Estimate of the number of bytes to process.
- InspectDataSourceDetails_Result::getInfoTypeStats() — Method in class InspectDataSourceDetails_Result
- Statistics of how many instances of each info type were found during inspect job.
- InspectJobConfig::getStorageConfig() — Method in class InspectJobConfig
- The data to scan.
- InspectJobConfig::getInspectConfig() — Method in class InspectJobConfig
- How and what to scan for.
- InspectJobConfig::getInspectTemplateName() — Method in class InspectJobConfig
- If provided, will be used as the default for all values in InspectConfig.
- InspectJobConfig::getActions() — Method in class InspectJobConfig
- Actions to execute at the completion of the job. Are executed in the order provided.
- InspectResult::getFindings() — Method in class InspectResult
- List of findings for an item.
- InspectResult::getFindingsTruncated() — Method in class InspectResult
- If true, then this item might have more findings than were returned, and the findings returned are an arbitrary subset of all findings.
- InspectTemplate::getName() — Method in class InspectTemplate
- The template name. Output only.
- InspectTemplate::getDisplayName() — Method in class InspectTemplate
- Display name (max 256 chars).
- InspectTemplate::getDescription() — Method in class InspectTemplate
- Short description (max 256 chars).
- InspectTemplate::getCreateTime() — Method in class InspectTemplate
- The creation timestamp of a inspectTemplate, output only field.
- InspectTemplate::getUpdateTime() — Method in class InspectTemplate
- The last update timestamp of a inspectTemplate, output only field.
- InspectTemplate::getInspectConfig() — Method in class InspectTemplate
- The core content of the template. Configuration of the scanning process.
- JobTrigger::getName() — Method in class JobTrigger
- Unique resource name for the triggeredJob, assigned by the service when the
triggeredJob is created, for example
projects/dlp-test-project/triggeredJobs/53234423. - JobTrigger::getDisplayName() — Method in class JobTrigger
- Display name (max 100 chars)
- JobTrigger::getDescription() — Method in class JobTrigger
- User provided description (max 256 chars)
- JobTrigger::getInspectJob() — Method in class JobTrigger
- Generated from protobuf field
.google.privacy.dlp.v2.InspectJobConfig inspect_job = 4; - JobTrigger::getTriggers() — Method in class JobTrigger
- A list of triggers which will be OR'ed together. Only one in the list needs to trigger for a job to be started. The list may contain only a single Schedule trigger and must have at least one object.
- JobTrigger::getErrors() — Method in class JobTrigger
- A stream of errors encountered when the trigger was activated. Repeated errors may result in the JobTrigger automaticaly being paused.
- JobTrigger::getCreateTime() — Method in class JobTrigger
- The creation timestamp of a triggeredJob, output only field.
- JobTrigger::getUpdateTime() — Method in class JobTrigger
- The last update timestamp of a triggeredJob, output only field.
- JobTrigger::getLastRunTime() — Method in class JobTrigger
- The timestamp of the last time this trigger executed, output only field.
- JobTrigger::getStatus() — Method in class JobTrigger
- A status for this trigger. [required]
- JobTrigger::getJob() — Method in class JobTrigger
- JobTrigger_Trigger::getSchedule() — Method in class JobTrigger_Trigger
- Create a job on a repeating basis based on the elapse of time.
- JobTrigger_Trigger::getTrigger() — Method in class JobTrigger_Trigger
- Key::getPartitionId() — Method in class Key
- Entities are partitioned into subsets, currently identified by a project ID and namespace ID.
- Key::getPath() — Method in class Key
- The entity path.
- Key_PathElement::getKind() — Method in class Key_PathElement
- The kind of the entity.
- Key_PathElement::getId() — Method in class Key_PathElement
- The auto-allocated ID of the entity.
- Key_PathElement::getName() — Method in class Key_PathElement
- The name of the entity.
- Key_PathElement::getIdType() — Method in class Key_PathElement
- KindExpression::getName() — Method in class KindExpression
- The name of the kind.
- KmsWrappedCryptoKey::getWrappedKey() — Method in class KmsWrappedCryptoKey
- The wrapped data crypto key. [required]
- KmsWrappedCryptoKey::getCryptoKeyName() — Method in class KmsWrappedCryptoKey
- The resource name of the KMS CryptoKey to use for unwrapping. [required]
- ListDeidentifyTemplatesRequest::getParent() — Method in class ListDeidentifyTemplatesRequest
- The parent resource name, for example projects/my-project-id or organizations/my-org-id.
- ListDeidentifyTemplatesRequest::getPageToken() — Method in class ListDeidentifyTemplatesRequest
- Optional page token to continue retrieval. Comes from previous call
to
ListDeidentifyTemplates. - ListDeidentifyTemplatesRequest::getPageSize() — Method in class ListDeidentifyTemplatesRequest
- Optional size of the page, can be limited by server. If zero server returns a page of max size 100.
- ListDeidentifyTemplatesResponse::getDeidentifyTemplates() — Method in class ListDeidentifyTemplatesResponse
- List of deidentify templates, up to page_size in ListDeidentifyTemplatesRequest.
- ListDeidentifyTemplatesResponse::getNextPageToken() — Method in class ListDeidentifyTemplatesResponse
- If the next page is available then the next page token to be used in following ListDeidentifyTemplates request.
- ListDlpJobsRequest::getParent() — Method in class ListDlpJobsRequest
- The parent resource name, for example projects/my-project-id.
- ListDlpJobsRequest::getFilter() — Method in class ListDlpJobsRequest
- Optional. Allows filtering.
- ListDlpJobsRequest::getPageSize() — Method in class ListDlpJobsRequest
- The standard list page size.
- ListDlpJobsRequest::getPageToken() — Method in class ListDlpJobsRequest
- The standard list page token.
- ListDlpJobsRequest::getType() — Method in class ListDlpJobsRequest
- The type of job. Defaults to
DlpJobType.INSPECT - ListDlpJobsResponse::getJobs() — Method in class ListDlpJobsResponse
- A list of DlpJobs that matches the specified filter in the request.
- ListDlpJobsResponse::getNextPageToken() — Method in class ListDlpJobsResponse
- The standard List next-page token.
- ListInfoTypesRequest::getLanguageCode() — Method in class ListInfoTypesRequest
- Optional BCP-47 language code for localized infoType friendly names. If omitted, or if localized strings are not available, en-US strings will be returned.
- ListInfoTypesRequest::getFilter() — Method in class ListInfoTypesRequest
- Optional filter to only return infoTypes supported by certain parts of the API. Defaults to supported_by=INSPECT.
- ListInfoTypesResponse::getInfoTypes() — Method in class ListInfoTypesResponse
- Set of sensitive infoTypes.
- ListInspectTemplatesRequest::getParent() — Method in class ListInspectTemplatesRequest
- The parent resource name, for example projects/my-project-id or organizations/my-org-id.
- ListInspectTemplatesRequest::getPageToken() — Method in class ListInspectTemplatesRequest
- Optional page token to continue retrieval. Comes from previous call
to
ListInspectTemplates. - ListInspectTemplatesRequest::getPageSize() — Method in class ListInspectTemplatesRequest
- Optional size of the page, can be limited by server. If zero server returns a page of max size 100.
- ListInspectTemplatesResponse::getInspectTemplates() — Method in class ListInspectTemplatesResponse
- List of inspectTemplates, up to page_size in ListInspectTemplatesRequest.
- ListInspectTemplatesResponse::getNextPageToken() — Method in class ListInspectTemplatesResponse
- If the next page is available then the next page token to be used in following ListInspectTemplates request.
- ListJobTriggersRequest::getParent() — Method in class ListJobTriggersRequest
- The parent resource name, for example projects/my-project-id.
- ListJobTriggersRequest::getPageToken() — Method in class ListJobTriggersRequest
- Optional page token to continue retrieval. Comes from previous call
to ListJobTriggers.
order_byandfiltershould not change for subsequent calls, but can be omitted if token is specified. - ListJobTriggersRequest::getPageSize() — Method in class ListJobTriggersRequest
- Optional size of the page, can be limited by a server.
- ListJobTriggersRequest::getOrderBy() — Method in class ListJobTriggersRequest
- Optional comma separated list of triggeredJob fields to order by, followed by 'asc/desc' postfix, i.e.
- ListJobTriggersResponse::getJobTriggers() — Method in class ListJobTriggersResponse
- List of triggeredJobs, up to page_size in ListJobTriggersRequest.
- ListJobTriggersResponse::getNextPageToken() — Method in class ListJobTriggersResponse
- If the next page is available then the next page token to be used in following ListJobTriggers request.
- Location::getByteRange() — Method in class Location
- Zero-based byte offsets delimiting the finding.
- Location::getCodepointRange() — Method in class Location
- Unicode character offsets delimiting the finding.
- Location::getContentLocations() — Method in class Location
- List of nested objects pointing to the precise location of the finding within the file or record.
- OutputStorageConfig::getTable() — Method in class OutputStorageConfig
- Store findings in an existing table or a new table in an existing
dataset. Each column in an existing table must have the same name, type,
and mode of a field in the
Findingobject. If table_id is not set a new one will be generated for you with the following format: dlp_googleapis_yyyy_mm_dd_[dlp_job_id]. Pacific timezone will be used for generating the date details. - OutputStorageConfig::getOutputSchema() — Method in class OutputStorageConfig
- Schema used for writing the findings. Columns are derived from the
Findingobject. If appending to an existing table, any columns from the predefined schema that are missing will be added. No columns in the existing table will be deleted. - OutputStorageConfig::getType() — Method in class OutputStorageConfig
- PartitionId::getProjectId() — Method in class PartitionId
- The ID of the project to which the entities belong.
- PartitionId::getNamespaceId() — Method in class PartitionId
- If not empty, the ID of the namespace to which the entities belong.
- PrimitiveTransformation::getReplaceConfig() — Method in class PrimitiveTransformation
- Generated from protobuf field
.google.privacy.dlp.v2.ReplaceValueConfig replace_config = 1; - PrimitiveTransformation::getRedactConfig() — Method in class PrimitiveTransformation
- Generated from protobuf field
.google.privacy.dlp.v2.RedactConfig redact_config = 2; - PrimitiveTransformation::getCharacterMaskConfig() — Method in class PrimitiveTransformation
- Generated from protobuf field
.google.privacy.dlp.v2.CharacterMaskConfig character_mask_config = 3; - PrimitiveTransformation::getCryptoReplaceFfxFpeConfig() — Method in class PrimitiveTransformation
- Generated from protobuf field
.google.privacy.dlp.v2.CryptoReplaceFfxFpeConfig crypto_replace_ffx_fpe_config = 4; - PrimitiveTransformation::getFixedSizeBucketingConfig() — Method in class PrimitiveTransformation
- Generated from protobuf field
.google.privacy.dlp.v2.FixedSizeBucketingConfig fixed_size_bucketing_config = 5; - PrimitiveTransformation::getBucketingConfig() — Method in class PrimitiveTransformation
- Generated from protobuf field
.google.privacy.dlp.v2.BucketingConfig bucketing_config = 6; - PrimitiveTransformation::getReplaceWithInfoTypeConfig() — Method in class PrimitiveTransformation
- Generated from protobuf field
.google.privacy.dlp.v2.ReplaceWithInfoTypeConfig replace_with_info_type_config = 7; - PrimitiveTransformation::getTimePartConfig() — Method in class PrimitiveTransformation
- Generated from protobuf field
.google.privacy.dlp.v2.TimePartConfig time_part_config = 8; - PrimitiveTransformation::getCryptoHashConfig() — Method in class PrimitiveTransformation
- Generated from protobuf field
.google.privacy.dlp.v2.CryptoHashConfig crypto_hash_config = 9; - PrimitiveTransformation::getDateShiftConfig() — Method in class PrimitiveTransformation
- Generated from protobuf field
.google.privacy.dlp.v2.DateShiftConfig date_shift_config = 11; - PrimitiveTransformation::getTransformation() — Method in class PrimitiveTransformation
- PrivacyMetric::getNumericalStatsConfig() — Method in class PrivacyMetric
- Generated from protobuf field
.google.privacy.dlp.v2.PrivacyMetric.NumericalStatsConfig numerical_stats_config = 1; - PrivacyMetric::getCategoricalStatsConfig() — Method in class PrivacyMetric
- Generated from protobuf field
.google.privacy.dlp.v2.PrivacyMetric.CategoricalStatsConfig categorical_stats_config = 2; - PrivacyMetric::getKAnonymityConfig() — Method in class PrivacyMetric
- Generated from protobuf field
.google.privacy.dlp.v2.PrivacyMetric.KAnonymityConfig k_anonymity_config = 3; - PrivacyMetric::getLDiversityConfig() — Method in class PrivacyMetric
- Generated from protobuf field
.google.privacy.dlp.v2.PrivacyMetric.LDiversityConfig l_diversity_config = 4; - PrivacyMetric::getKMapEstimationConfig() — Method in class PrivacyMetric
- Generated from protobuf field
.google.privacy.dlp.v2.PrivacyMetric.KMapEstimationConfig k_map_estimation_config = 5; - PrivacyMetric::getType() — Method in class PrivacyMetric
- PrivacyMetric_CategoricalStatsConfig::getField() — Method in class PrivacyMetric_CategoricalStatsConfig
- Field to compute categorical stats on. All column types are supported except for arrays and structs. However, it may be more informative to use NumericalStats when the field type is supported, depending on the data.
- PrivacyMetric_KAnonymityConfig::getQuasiIds() — Method in class PrivacyMetric_KAnonymityConfig
- Set of fields to compute k-anonymity over. When multiple fields are specified, they are considered a single composite key. Structs and repeated data types are not supported; however, nested fields are supported so long as they are not structs themselves or nested within a repeated field.
- PrivacyMetric_KAnonymityConfig::getEntityId() — Method in class PrivacyMetric_KAnonymityConfig
- Optional message indicating that multiple rows might be associated to a single individual. If the same entity_id is associated to multiple quasi-identifier tuples over distict rows, we consider the entire collection of tuples as the composite quasi-identifier. This collection is a multiset: the order in which the different tuples appear in the dataset is ignored, but their frequency is taken into account.
- PrivacyMetric_KMapEstimationConfig::getQuasiIds() — Method in class PrivacyMetric_KMapEstimationConfig
- Fields considered to be quasi-identifiers. No two columns can have the same tag. [required]
- PrivacyMetric_KMapEstimationConfig::getRegionCode() — Method in class PrivacyMetric_KMapEstimationConfig
- ISO 3166-1 alpha-2 region code to use in the statistical modeling.
- PrivacyMetric_KMapEstimationConfig::getAuxiliaryTables() — Method in class PrivacyMetric_KMapEstimationConfig
- Several auxiliary tables can be used in the analysis. Each custom_tag used to tag a quasi-identifiers column must appear in exactly one column of one auxiliary table.
- PrivacyMetric_KMapEstimationConfig_AuxiliaryTable::getTable() — Method in class PrivacyMetric_KMapEstimationConfig_AuxiliaryTable
- Auxiliary table location. [required]
- PrivacyMetric_KMapEstimationConfig_AuxiliaryTable::getQuasiIds() — Method in class PrivacyMetric_KMapEstimationConfig_AuxiliaryTable
- Quasi-identifier columns. [required]
- PrivacyMetric_KMapEstimationConfig_AuxiliaryTable::getRelativeFrequency() — Method in class PrivacyMetric_KMapEstimationConfig_AuxiliaryTable
- The relative frequency column must contain a floating-point number between 0 and 1 (inclusive). Null values are assumed to be zero.
- PrivacyMetric_KMapEstimationConfig_AuxiliaryTable_QuasiIdField::getField() — Method in class PrivacyMetric_KMapEstimationConfig_AuxiliaryTable_QuasiIdField
- Generated from protobuf field
.google.privacy.dlp.v2.FieldId field = 1; - PrivacyMetric_KMapEstimationConfig_AuxiliaryTable_QuasiIdField::getCustomTag() — Method in class PrivacyMetric_KMapEstimationConfig_AuxiliaryTable_QuasiIdField
- Generated from protobuf field
string custom_tag = 2; - PrivacyMetric_KMapEstimationConfig_TaggedField::getField() — Method in class PrivacyMetric_KMapEstimationConfig_TaggedField
- Identifies the column. [required]
- PrivacyMetric_KMapEstimationConfig_TaggedField::getInfoType() — Method in class PrivacyMetric_KMapEstimationConfig_TaggedField
- A column can be tagged with a InfoType to use the relevant public dataset as a statistical model of population, if available. We currently support US ZIP codes, region codes, ages and genders.
- PrivacyMetric_KMapEstimationConfig_TaggedField::getCustomTag() — Method in class PrivacyMetric_KMapEstimationConfig_TaggedField
- A column can be tagged with a custom tag. In this case, the user must indicate an auxiliary table that contains statistical information on the possible values of this column (below).
- PrivacyMetric_KMapEstimationConfig_TaggedField::getInferred() — Method in class PrivacyMetric_KMapEstimationConfig_TaggedField
- If no semantic tag is indicated, we infer the statistical model from the distribution of values in the input data
- PrivacyMetric_KMapEstimationConfig_TaggedField::getTag() — Method in class PrivacyMetric_KMapEstimationConfig_TaggedField
- PrivacyMetric_LDiversityConfig::getQuasiIds() — Method in class PrivacyMetric_LDiversityConfig
- Set of quasi-identifiers indicating how equivalence classes are defined for the l-diversity computation. When multiple fields are specified, they are considered a single composite key.
- PrivacyMetric_LDiversityConfig::getSensitiveAttribute() — Method in class PrivacyMetric_LDiversityConfig
- Sensitive field for computing the l-value.
- PrivacyMetric_NumericalStatsConfig::getField() — Method in class PrivacyMetric_NumericalStatsConfig
- Field to compute numerical stats on. Supported types are integer, float, date, datetime, timestamp, time.
- QuoteInfo::getDateTime() — Method in class QuoteInfo
- Generated from protobuf field
.google.privacy.dlp.v2.DateTime date_time = 2; - QuoteInfo::getParsedQuote() — Method in class QuoteInfo
- Range::getStart() — Method in class Range
- Index of the first character of the range (inclusive).
- Range::getEnd() — Method in class Range
- Index of the last character of the range (exclusive).
- RecordCondition::getExpressions() — Method in class RecordCondition
- An expression.
- RecordCondition_Condition::getField() — Method in class RecordCondition_Condition
- Field within the record this condition is evaluated against. [required]
- RecordCondition_Condition::getOperator() — Method in class RecordCondition_Condition
- Operator used to compare the field or infoType to the value. [required]
- RecordCondition_Condition::getValue() — Method in class RecordCondition_Condition
- Value to compare against. [Required, except for
EXISTStests.] - RecordCondition_Conditions::getConditions() — Method in class RecordCondition_Conditions
- Generated from protobuf field
repeated .google.privacy.dlp.v2.RecordCondition.Condition conditions = 1; - RecordCondition_Expressions::getLogicalOperator() — Method in class RecordCondition_Expressions
- The operator to apply to the result of conditions. Default and currently
only supported value is
AND. - RecordCondition_Expressions::getConditions() — Method in class RecordCondition_Expressions
- Generated from protobuf field
.google.privacy.dlp.v2.RecordCondition.Conditions conditions = 3; - RecordCondition_Expressions::getType() — Method in class RecordCondition_Expressions
- RecordKey::getDatastoreKey() — Method in class RecordKey
- Generated from protobuf field
.google.privacy.dlp.v2.DatastoreKey datastore_key = 2; - RecordKey::getBigQueryKey() — Method in class RecordKey
- Generated from protobuf field
.google.privacy.dlp.v2.BigQueryKey big_query_key = 3; - RecordKey::getType() — Method in class RecordKey
- RecordLocation::getRecordKey() — Method in class RecordLocation
- Key of the finding.
- RecordLocation::getFieldId() — Method in class RecordLocation
- Field id of the field containing the finding.
- RecordLocation::getTableLocation() — Method in class RecordLocation
- Location within a
ContentItem.Table. - RecordSuppression::getCondition() — Method in class RecordSuppression
- A condition that when it evaluates to true will result in the record being evaluated to be suppressed from the transformed content.
- RecordTransformations::getFieldTransformations() — Method in class RecordTransformations
- Transform the record by applying various field transformations.
- RecordTransformations::getRecordSuppressions() — Method in class RecordTransformations
- Configuration defining which records get suppressed entirely. Records that match any suppression rule are omitted from the output [optional].
- RedactImageRequest::getParent() — Method in class RedactImageRequest
- The parent resource name, for example projects/my-project-id.
- RedactImageRequest::getInspectConfig() — Method in class RedactImageRequest
- Configuration for the inspector.
- RedactImageRequest::getImageRedactionConfigs() — Method in class RedactImageRequest
- The configuration for specifying what content to redact from images.
- RedactImageRequest::getByteItem() — Method in class RedactImageRequest
- The content must be PNG, JPEG, SVG or BMP.
- RedactImageRequest_ImageRedactionConfig::getInfoType() — Method in class RedactImageRequest_ImageRedactionConfig
- Only one per info_type should be provided per request. If not specified, and redact_all_text is false, the DLP API will redact all text that it matches against all info_types that are found, but not specified in another ImageRedactionConfig.
- RedactImageRequest_ImageRedactionConfig::getRedactAllText() — Method in class RedactImageRequest_ImageRedactionConfig
- If true, all text found in the image, regardless whether it matches an info_type, is redacted.
- RedactImageRequest_ImageRedactionConfig::getRedactionColor() — Method in class RedactImageRequest_ImageRedactionConfig
- The color to use when redacting content from an image. If not specified, the default is black.
- RedactImageRequest_ImageRedactionConfig::getTarget() — Method in class RedactImageRequest_ImageRedactionConfig
- RedactImageResponse::getRedactedImage() — Method in class RedactImageResponse
- The redacted image. The type will be the same as the original image.
- RedactImageResponse::getExtractedText() — Method in class RedactImageResponse
- If an image was being inspected and the InspectConfig's include_quote was set to true, then this field will include all text, if any, that was found in the image.
- ReidentifyContentRequest::getParent() — Method in class ReidentifyContentRequest
- The parent resource name.
- ReidentifyContentRequest::getReidentifyConfig() — Method in class ReidentifyContentRequest
- Configuration for the re-identification of the content item.
- ReidentifyContentRequest::getInspectConfig() — Method in class ReidentifyContentRequest
- Configuration for the inspector.
- ReidentifyContentRequest::getItem() — Method in class ReidentifyContentRequest
- The item to re-identify. Will be treated as text.
- ReidentifyContentRequest::getInspectTemplateName() — Method in class ReidentifyContentRequest
- Optional template to use. Any configuration directly specified in
inspect_configwill override those set in the template. Singular fields that are set in this request will replace their corresponding fields in the template. Repeated fields are appended. Singular sub-messages and groups are recursively merged. - ReidentifyContentRequest::getReidentifyTemplateName() — Method in class ReidentifyContentRequest
- Optional template to use. References an instance of
DeidentifyTemplate. - ReidentifyContentResponse::getItem() — Method in class ReidentifyContentResponse
- The re-identified item.
- ReidentifyContentResponse::getOverview() — Method in class ReidentifyContentResponse
- An overview of the changes that were made to the
item. - ReplaceValueConfig::getNewValue() — Method in class ReplaceValueConfig
- Value to replace it with.
- RiskAnalysisJobConfig::getPrivacyMetric() — Method in class RiskAnalysisJobConfig
- Privacy metric to compute.
- RiskAnalysisJobConfig::getSourceTable() — Method in class RiskAnalysisJobConfig
- Input dataset to compute metrics over.
- RiskAnalysisJobConfig::getActions() — Method in class RiskAnalysisJobConfig
- Actions to execute at the completion of the job. Are executed in the order provided.
- Schedule::getRecurrencePeriodDuration() — Method in class Schedule
- With this option a job is started a regular periodic basis. For example: every 10 minutes.
- Schedule::getOption() — Method in class Schedule
- StorageConfig::getDatastoreOptions() — Method in class StorageConfig
- Google Cloud Datastore options specification.
- StorageConfig::getCloudStorageOptions() — Method in class StorageConfig
- Google Cloud Storage options specification.
- StorageConfig::getBigQueryOptions() — Method in class StorageConfig
- BigQuery options specification.
- StorageConfig::getTimespanConfig() — Method in class StorageConfig
- Generated from protobuf field
.google.privacy.dlp.v2.StorageConfig.TimespanConfig timespan_config = 6; - StorageConfig::getType() — Method in class StorageConfig
- StorageConfig_TimespanConfig::getStartTime() — Method in class StorageConfig_TimespanConfig
- Exclude files older than this value.
- StorageConfig_TimespanConfig::getEndTime() — Method in class StorageConfig_TimespanConfig
- Exclude files newer than this value.
- StorageConfig_TimespanConfig::getTimestampField() — Method in class StorageConfig_TimespanConfig
- Specification of the field containing the timestamp of scanned items.
- StorageConfig_TimespanConfig::getEnableAutoPopulationOfTimespanConfig() — Method in class StorageConfig_TimespanConfig
- When the job is started by a JobTrigger we will automatically figure out a valid start_time to avoid scanning files that have not been modified since the last time the JobTrigger executed. This will be based on the time of the execution of the last run of the JobTrigger.
- Table::getHeaders() — Method in class Table
- Generated from protobuf field
repeated .google.privacy.dlp.v2.FieldId headers = 1; - Table::getRows() — Method in class Table
- Generated from protobuf field
repeated .google.privacy.dlp.v2.Table.Row rows = 2; - TableLocation::getRowIndex() — Method in class TableLocation
- The zero-based index of the row where the finding is located.
- Table_Row::getValues() — Method in class Table_Row
- Generated from protobuf field
repeated .google.privacy.dlp.v2.Value values = 1; - TimePartConfig::getPartToExtract() — Method in class TimePartConfig
- Generated from protobuf field
.google.privacy.dlp.v2.TimePartConfig.TimePart part_to_extract = 1; - TransformationOverview::getTransformedBytes() — Method in class TransformationOverview
- Total size in bytes that were transformed in some way.
- TransformationOverview::getTransformationSummaries() — Method in class TransformationOverview
- Transformations applied to the dataset.
- TransformationSummary::getInfoType() — Method in class TransformationSummary
- Set if the transformation was limited to a specific info_type.
- TransformationSummary::getField() — Method in class TransformationSummary
- Set if the transformation was limited to a specific FieldId.
- TransformationSummary::getTransformation() — Method in class TransformationSummary
- The specific transformation these stats apply to.
- TransformationSummary::getFieldTransformations() — Method in class TransformationSummary
- The field transformation that was applied.
- TransformationSummary::getRecordSuppress() — Method in class TransformationSummary
- The specific suppression option these stats apply to.
- TransformationSummary::getResults() — Method in class TransformationSummary
- Generated from protobuf field
repeated .google.privacy.dlp.v2.TransformationSummary.SummaryResult results = 4; - TransformationSummary::getTransformedBytes() — Method in class TransformationSummary
- Total size in bytes that were transformed in some way.
- TransformationSummary_SummaryResult::getCount() — Method in class TransformationSummary_SummaryResult
- Generated from protobuf field
int64 count = 1; - TransformationSummary_SummaryResult::getCode() — Method in class TransformationSummary_SummaryResult
- Generated from protobuf field
.google.privacy.dlp.v2.TransformationSummary.TransformationResultCode code = 2; - TransformationSummary_SummaryResult::getDetails() — Method in class TransformationSummary_SummaryResult
- A place for warnings or errors to show up if a transformation didn't work as expected.
- TransientCryptoKey::getName() — Method in class TransientCryptoKey
- Name of the key. [required] This is an arbitrary string used to differentiate different keys.
- UnwrappedCryptoKey::getKey() — Method in class UnwrappedCryptoKey
- The AES 128/192/256 bit key. [required]
- UpdateDeidentifyTemplateRequest::getName() — Method in class UpdateDeidentifyTemplateRequest
- Resource name of organization and deidentify template to be updated, for
example
organizations/433245324/deidentifyTemplates/432452342or projects/project-id/deidentifyTemplates/432452342. - UpdateDeidentifyTemplateRequest::getDeidentifyTemplate() — Method in class UpdateDeidentifyTemplateRequest
- New DeidentifyTemplate value.
- UpdateDeidentifyTemplateRequest::getUpdateMask() — Method in class UpdateDeidentifyTemplateRequest
- Mask to control which fields get updated.
- UpdateInspectTemplateRequest::getName() — Method in class UpdateInspectTemplateRequest
- Resource name of organization and inspectTemplate to be updated, for
example
organizations/433245324/inspectTemplates/432452342or projects/project-id/inspectTemplates/432452342. - UpdateInspectTemplateRequest::getInspectTemplate() — Method in class UpdateInspectTemplateRequest
- New InspectTemplate value.
- UpdateInspectTemplateRequest::getUpdateMask() — Method in class UpdateInspectTemplateRequest
- Mask to control which fields get updated.
- UpdateJobTriggerRequest::getName() — Method in class UpdateJobTriggerRequest
- Resource name of the project and the triggeredJob, for example
projects/dlp-test-project/jobTriggers/53234423. - UpdateJobTriggerRequest::getJobTrigger() — Method in class UpdateJobTriggerRequest
- New JobTrigger value.
- UpdateJobTriggerRequest::getUpdateMask() — Method in class UpdateJobTriggerRequest
- Mask to control which fields get updated.
- Value::getIntegerValue() — Method in class Value
- Generated from protobuf field
int64 integer_value = 1; - Value::getFloatValue() — Method in class Value
- Generated from protobuf field
double float_value = 2; - Value::getStringValue() — Method in class Value
- Generated from protobuf field
string string_value = 3; - Value::getBooleanValue() — Method in class Value
- Generated from protobuf field
bool boolean_value = 4; - Value::getTimestampValue() — Method in class Value
- Generated from protobuf field
.google.protobuf.Timestamp timestamp_value = 5; - Value::getTimeValue() — Method in class Value
- Generated from protobuf field
.google.type.TimeOfDay time_value = 6; - Value::getDateValue() — Method in class Value
- Generated from protobuf field
.google.type.Date date_value = 7; - Value::getDayOfWeekValue() — Method in class Value
- Generated from protobuf field
.google.type.DayOfWeek day_of_week_value = 8; - Value::getType() — Method in class Value
- ValueFrequency::getValue() — Method in class ValueFrequency
- A value contained in the field in question.
- ValueFrequency::getCount() — Method in class ValueFrequency
- How many times the value is contained in the field.
- DeleteEventsRequest::getProjectName() — Method in class DeleteEventsRequest
- [Required] The resource name of the Google Cloud Platform project. Written
as
projects/plus the Google Cloud Platform project ID. - ErrorContext::getHttpRequest() — Method in class ErrorContext
- The HTTP request which was processed when the error was triggered.
- ErrorContext::getUser() — Method in class ErrorContext
- The user who caused or was affected by the crash.
- ErrorContext::getReportLocation() — Method in class ErrorContext
- The location in the source code where the decision was made to report the error, usually the place where it was logged.
- ErrorEvent::getEventTime() — Method in class ErrorEvent
- Time when the event occurred as provided in the error report.
- ErrorEvent::getServiceContext() — Method in class ErrorEvent
- The
ServiceContextfor which this error was reported. - ErrorEvent::getMessage() — Method in class ErrorEvent
- The stack trace that was reported or logged by the service.
- ErrorEvent::getContext() — Method in class ErrorEvent
- Data about the context in which the error occurred.
- ErrorGroup::getName() — Method in class ErrorGroup
- The group resource name.
- ErrorGroup::getGroupId() — Method in class ErrorGroup
- Group IDs are unique for a given project. If the same kind of error occurs in different service contexts, it will receive the same group ID.
- ErrorGroup::getTrackingIssues() — Method in class ErrorGroup
- Associated tracking issues.
- ErrorGroupServiceGrpcClient::GetGroup() — Method in class ErrorGroupServiceGrpcClient
- Get the specified group.
- ErrorGroupStats::getGroup() — Method in class ErrorGroupStats
- Group data that is independent of the filter criteria.
- ErrorGroupStats::getCount() — Method in class ErrorGroupStats
- Approximate total number of events in the given group that match the filter criteria.
- ErrorGroupStats::getAffectedUsersCount() — Method in class ErrorGroupStats
- Approximate number of affected users in the given group that match the filter criteria.
- ErrorGroupStats::getTimedCounts() — Method in class ErrorGroupStats
- Approximate number of occurrences over time.
- ErrorGroupStats::getFirstSeenTime() — Method in class ErrorGroupStats
- Approximate first occurrence that was ever seen for this group and which matches the given filter criteria, ignoring the time_range that was specified in the request.
- ErrorGroupStats::getLastSeenTime() — Method in class ErrorGroupStats
- Approximate last occurrence that was ever seen for this group and which matches the given filter criteria, ignoring the time_range that was specified in the request.
- ErrorGroupStats::getAffectedServices() — Method in class ErrorGroupStats
- Service contexts with a non-zero error count for the given filter criteria. This list can be truncated if multiple services are affected.
- ErrorGroupStats::getNumAffectedServices() — Method in class ErrorGroupStats
- The total number of services with a non-zero error count for the given filter criteria.
- ErrorGroupStats::getRepresentative() — Method in class ErrorGroupStats
- An arbitrary event that is chosen as representative for the whole group.
- GetGroupRequest — Class in namespace Google\Cloud\ErrorReporting\V1beta1
- A request to return an individual group.
- GetGroupRequest::getGroupName() — Method in class GetGroupRequest
- [Required] The group resource name. Written as
projects/projectID/groups/group_name. - HttpRequestContext::getMethod() — Method in class HttpRequestContext
- The type of HTTP request, such as
GET,POST, etc. - HttpRequestContext::getUrl() — Method in class HttpRequestContext
- The URL of the request.
- HttpRequestContext::getUserAgent() — Method in class HttpRequestContext
- The user agent information that is provided with the request.
- HttpRequestContext::getReferrer() — Method in class HttpRequestContext
- The referrer information that is provided with the request.
- HttpRequestContext::getResponseStatusCode() — Method in class HttpRequestContext
- The HTTP response status code for the request.
- HttpRequestContext::getRemoteIp() — Method in class HttpRequestContext
- The IP address from which the request originated.
- ListEventsRequest::getProjectName() — Method in class ListEventsRequest
- [Required] The resource name of the Google Cloud Platform project. Written
as
projects/plus the Google Cloud Platform project ID. - ListEventsRequest::getGroupId() — Method in class ListEventsRequest
- [Required] The group for which events shall be returned.
- ListEventsRequest::getServiceFilter() — Method in class ListEventsRequest
- [Optional] List only ErrorGroups which belong to a service context that matches the filter.
- ListEventsRequest::getTimeRange() — Method in class ListEventsRequest
- [Optional] List only data for the given time range.
- ListEventsRequest::getPageSize() — Method in class ListEventsRequest
- [Optional] The maximum number of results to return per response.
- ListEventsRequest::getPageToken() — Method in class ListEventsRequest
- [Optional] A
next_page_tokenprovided by a previous response. - ListEventsResponse::getErrorEvents() — Method in class ListEventsResponse
- The error events which match the given request.
- ListEventsResponse::getNextPageToken() — Method in class ListEventsResponse
- If non-empty, more results are available.
- ListEventsResponse::getTimeRangeBegin() — Method in class ListEventsResponse
- The timestamp specifies the start time to which the request was restricted.
- ListGroupStatsRequest::getProjectName() — Method in class ListGroupStatsRequest
- [Required] The resource name of the Google Cloud Platform project. Written
as
projects/plus the Google Cloud Platform project ID. - ListGroupStatsRequest::getGroupId() — Method in class ListGroupStatsRequest
- [Optional] List all
ErrorGroupStatswith these IDs. - ListGroupStatsRequest::getServiceFilter() — Method in class ListGroupStatsRequest
- [Optional] List only
ErrorGroupStatswhich belong to a service context that matches the filter. - ListGroupStatsRequest::getTimeRange() — Method in class ListGroupStatsRequest
- [Optional] List data for the given time range.
- ListGroupStatsRequest::getTimedCountDuration() — Method in class ListGroupStatsRequest
- [Optional] The preferred duration for a single returned
TimedCount. - ListGroupStatsRequest::getAlignment() — Method in class ListGroupStatsRequest
- [Optional] The alignment of the timed counts to be returned.
- ListGroupStatsRequest::getAlignmentTime() — Method in class ListGroupStatsRequest
- [Optional] Time where the timed counts shall be aligned if rounded alignment is chosen. Default is 00:00 UTC.
- ListGroupStatsRequest::getOrder() — Method in class ListGroupStatsRequest
- [Optional] The sort order in which the results are returned.
- ListGroupStatsRequest::getPageSize() — Method in class ListGroupStatsRequest
- [Optional] The maximum number of results to return per response.
- ListGroupStatsRequest::getPageToken() — Method in class ListGroupStatsRequest
- [Optional] A
next_page_tokenprovided by a previous response. To view additional results, pass this token along with the identical query parameters as the first request. - ListGroupStatsResponse::getErrorGroupStats() — Method in class ListGroupStatsResponse
- The error group stats which match the given request.
- ListGroupStatsResponse::getNextPageToken() — Method in class ListGroupStatsResponse
- If non-empty, more results are available.
- ListGroupStatsResponse::getTimeRangeBegin() — Method in class ListGroupStatsResponse
- The timestamp specifies the start time to which the request was restricted.
- QueryTimeRange::getPeriod() — Method in class QueryTimeRange
- Restricts the query to the specified time range.
- ReportErrorEventRequest::getProjectName() — Method in class ReportErrorEventRequest
- [Required] The resource name of the Google Cloud Platform project. Written
as
projects/plus the Google Cloud Platform project ID. - ReportErrorEventRequest::getEvent() — Method in class ReportErrorEventRequest
- [Required] The error event to be reported.
- ReportedErrorEvent::getEventTime() — Method in class ReportedErrorEvent
- [Optional] Time when the event occurred.
- ReportedErrorEvent::getServiceContext() — Method in class ReportedErrorEvent
- [Required] The service context in which this error has occurred.
- ReportedErrorEvent::getMessage() — Method in class ReportedErrorEvent
- [Required] A message describing the error. The message can contain an exception stack in one of the supported programming languages and formats.
- ReportedErrorEvent::getContext() — Method in class ReportedErrorEvent
- [Optional] A description of the context in which the error occurred.
- ServiceContext::getService() — Method in class ServiceContext
- An identifier of the service, such as the name of the
executable, job, or Google App Engine service name. This field is expected
to have a low number of values that are relatively stable over time, as
opposed to
version, which can be changed whenever new code is deployed. - ServiceContext::getVersion() — Method in class ServiceContext
- Represents the source code version that the developer provided, which could represent a version label or a Git SHA-1 hash, for example.
- ServiceContext::getResourceType() — Method in class ServiceContext
- Type of the MonitoredResource. List of possible values: https://cloud.google.com/monitoring/api/resources Value is set automatically for incoming errors and must not be set when reporting errors.
- ServiceContextFilter::getService() — Method in class ServiceContextFilter
- [Optional] The exact value to match against
ServiceContext.service. - ServiceContextFilter::getVersion() — Method in class ServiceContextFilter
- [Optional] The exact value to match against
ServiceContext.version. - ServiceContextFilter::getResourceType() — Method in class ServiceContextFilter
- [Optional] The exact value to match against
ServiceContext.resource_type. - SourceLocation::getFilePath() — Method in class SourceLocation
- The source code filename, which can include a truncated relative path, or a full path from a production machine.
- SourceLocation::getLineNumber() — Method in class SourceLocation
- 1-based. 0 indicates that the line number is unknown.
- SourceLocation::getFunctionName() — Method in class SourceLocation
- Human-readable name of a function or method.
- TimedCount::getCount() — Method in class TimedCount
- Approximate number of occurrences in the given time period.
- TimedCount::getStartTime() — Method in class TimedCount
- Start of the time period to which
countrefers (included). - TimedCount::getEndTime() — Method in class TimedCount
- End of the time period to which
countrefers (excluded). - TrackingIssue::getUrl() — Method in class TrackingIssue
- A URL pointing to a related entry in an issue tracking system.
- UpdateGroupRequest::getGroup() — Method in class UpdateGroupRequest
- [Required] The group which replaces the resource on the server.
- ArrayValue::getValues() — Method in class ArrayValue
- Values in the array.
- BatchGetDocumentsRequest::getDatabase() — Method in class BatchGetDocumentsRequest
- The database name. In the format:
projects/{project_id}/databases/{database_id}. - BatchGetDocumentsRequest::getDocuments() — Method in class BatchGetDocumentsRequest
- The names of the documents to retrieve. In the format:
projects/{project_id}/databases/{database_id}/documents/{document_path}. - BatchGetDocumentsRequest::getMask() — Method in class BatchGetDocumentsRequest
- The fields to return. If not set, returns all fields.
- BatchGetDocumentsRequest::getTransaction() — Method in class BatchGetDocumentsRequest
- Reads documents in a transaction.
- BatchGetDocumentsRequest::getNewTransaction() — Method in class BatchGetDocumentsRequest
- Starts a new transaction and reads the documents.
- BatchGetDocumentsRequest::getReadTime() — Method in class BatchGetDocumentsRequest
- Reads documents as they were at the given time.
- BatchGetDocumentsRequest::getConsistencySelector() — Method in class BatchGetDocumentsRequest
- BatchGetDocumentsResponse::getFound() — Method in class BatchGetDocumentsResponse
- A document that was requested.
- BatchGetDocumentsResponse::getMissing() — Method in class BatchGetDocumentsResponse
- A document name that was requested but does not exist. In the format:
projects/{project_id}/databases/{database_id}/documents/{document_path}. - BatchGetDocumentsResponse::getTransaction() — Method in class BatchGetDocumentsResponse
- The transaction that was started as part of this request.
- BatchGetDocumentsResponse::getReadTime() — Method in class BatchGetDocumentsResponse
- The time at which the document was read.
- BatchGetDocumentsResponse::getResult() — Method in class BatchGetDocumentsResponse
- BeginTransactionRequest::getDatabase() — Method in class BeginTransactionRequest
- The database name. In the format:
projects/{project_id}/databases/{database_id}. - BeginTransactionRequest::getOptions() — Method in class BeginTransactionRequest
- The options for the transaction.
- BeginTransactionResponse::getTransaction() — Method in class BeginTransactionResponse
- The transaction that was started.
- CommitRequest::getDatabase() — Method in class CommitRequest
- The database name. In the format:
projects/{project_id}/databases/{database_id}. - CommitRequest::getWrites() — Method in class CommitRequest
- The writes to apply.
- CommitRequest::getTransaction() — Method in class CommitRequest
- If set, applies all writes in this transaction, and commits it.
- CommitResponse::getWriteResults() — Method in class CommitResponse
- The result of applying the writes.
- CommitResponse::getCommitTime() — Method in class CommitResponse
- The time at which the commit occurred.
- CreateDocumentRequest::getParent() — Method in class CreateDocumentRequest
- The parent resource. For example:
projects/{project_id}/databases/{database_id}/documentsorprojects/{project_id}/databases/{database_id}/documents/chatrooms/{chatroom_id} - CreateDocumentRequest::getCollectionId() — Method in class CreateDocumentRequest
- The collection ID, relative to
parent, to list. For example:chatrooms. - CreateDocumentRequest::getDocumentId() — Method in class CreateDocumentRequest
- The client-assigned document ID to use for this document.
- CreateDocumentRequest::getDocument() — Method in class CreateDocumentRequest
- The document to create.
namemust not be set. - CreateDocumentRequest::getMask() — Method in class CreateDocumentRequest
- The fields to return. If not set, returns all fields.
- Cursor::getValues() — Method in class Cursor
- The values that represent a position, in the order they appear in the order by clause of a query.
- Cursor::getBefore() — Method in class Cursor
- If the position is just before or just after the given values, relative to the sort order defined by the query.
- DeleteDocumentRequest::getName() — Method in class DeleteDocumentRequest
- The resource name of the Document to delete. In the format:
projects/{project_id}/databases/{database_id}/documents/{document_path}. - DeleteDocumentRequest::getCurrentDocument() — Method in class DeleteDocumentRequest
- An optional precondition on the document.
- Document::getName() — Method in class Document
- The resource name of the document, for example
projects/{project_id}/databases/{database_id}/documents/{document_path}. - Document::getFields() — Method in class Document
- The document's fields.
- Document::getCreateTime() — Method in class Document
- Output only. The time at which the document was created.
- Document::getUpdateTime() — Method in class Document
- Output only. The time at which the document was last changed.
- DocumentChange::getDocument() — Method in class DocumentChange
- The new state of the [Document][google.firestore.v1beta1.Document].
- DocumentChange::getTargetIds() — Method in class DocumentChange
- A set of target IDs of targets that match this document.
- DocumentChange::getRemovedTargetIds() — Method in class DocumentChange
- A set of target IDs for targets that no longer match this document.
- DocumentDelete::getDocument() — Method in class DocumentDelete
- The resource name of the [Document][google.firestore.v1beta1.Document] that was deleted.
- DocumentDelete::getRemovedTargetIds() — Method in class DocumentDelete
- A set of target IDs for targets that previously matched this entity.
- DocumentDelete::getReadTime() — Method in class DocumentDelete
- The read timestamp at which the delete was observed.
- DocumentMask::getFieldPaths() — Method in class DocumentMask
- The list of field paths in the mask. See [Document.fields][google.firestore.v1beta1.Document.fields] for a field path syntax reference.
- DocumentRemove::getDocument() — Method in class DocumentRemove
- The resource name of the [Document][google.firestore.v1beta1.Document] that has gone out of view.
- DocumentRemove::getRemovedTargetIds() — Method in class DocumentRemove
- A set of target IDs for targets that previously matched this document.
- DocumentRemove::getReadTime() — Method in class DocumentRemove
- The read timestamp at which the remove was observed.
- DocumentTransform::getDocument() — Method in class DocumentTransform
- The name of the document to transform.
- DocumentTransform::getFieldTransforms() — Method in class DocumentTransform
- The list of transformations to apply to the fields of the document, in order.
- DocumentTransform_FieldTransform::getFieldPath() — Method in class DocumentTransform_FieldTransform
- The path of the field. See [Document.fields][google.firestore.v1beta1.Document.fields] for the field path syntax reference.
- DocumentTransform_FieldTransform::getSetToServerValue() — Method in class DocumentTransform_FieldTransform
- Sets the field to the given server value.
- DocumentTransform_FieldTransform::getTransformType() — Method in class DocumentTransform_FieldTransform
- ExistenceFilter::getTargetId() — Method in class ExistenceFilter
- The target ID to which this filter applies.
- ExistenceFilter::getCount() — Method in class ExistenceFilter
- The total count of documents that match [target_id][google.firestore.v1beta1.ExistenceFilter.target_id].
- FirestoreGrpcClient::GetDocument() — Method in class FirestoreGrpcClient
- Gets a single document.
- GetDocumentRequest — Class in namespace Google\Cloud\Firestore\V1beta1
- The request for [Firestore.GetDocument][google.firestore.v1beta1.Firestore.GetDocument].
- GetDocumentRequest::getName() — Method in class GetDocumentRequest
- The resource name of the Document to get. In the format:
projects/{project_id}/databases/{database_id}/documents/{document_path}. - GetDocumentRequest::getMask() — Method in class GetDocumentRequest
- The fields to return. If not set, returns all fields.
- GetDocumentRequest::getTransaction() — Method in class GetDocumentRequest
- Reads the document in a transaction.
- GetDocumentRequest::getReadTime() — Method in class GetDocumentRequest
- Reads the version of the document at the given time.
- GetDocumentRequest::getConsistencySelector() — Method in class GetDocumentRequest
- ListCollectionIdsRequest::getParent() — Method in class ListCollectionIdsRequest
- The parent document. In the format:
projects/{project_id}/databases/{database_id}/documents/{document_path}. - ListCollectionIdsRequest::getPageSize() — Method in class ListCollectionIdsRequest
- The maximum number of results to return.
- ListCollectionIdsRequest::getPageToken() — Method in class ListCollectionIdsRequest
- A page token. Must be a value from [ListCollectionIdsResponse][google.firestore.v1beta1.ListCollectionIdsResponse].
- ListCollectionIdsResponse::getCollectionIds() — Method in class ListCollectionIdsResponse
- The collection ids.
- ListCollectionIdsResponse::getNextPageToken() — Method in class ListCollectionIdsResponse
- A page token that may be used to continue the list.
- ListDocumentsRequest::getParent() — Method in class ListDocumentsRequest
- The parent resource name. In the format:
projects/{project_id}/databases/{database_id}/documentsorprojects/{project_id}/databases/{database_id}/documents/{document_path}. - ListDocumentsRequest::getCollectionId() — Method in class ListDocumentsRequest
- The collection ID, relative to
parent, to list. For example:chatroomsormessages. - ListDocumentsRequest::getPageSize() — Method in class ListDocumentsRequest
- The maximum number of documents to return.
- ListDocumentsRequest::getPageToken() — Method in class ListDocumentsRequest
- The
next_page_tokenvalue returned from a previous List request, if any. - ListDocumentsRequest::getOrderBy() — Method in class ListDocumentsRequest
- The order to sort results by. For example:
priority desc, name. - ListDocumentsRequest::getMask() — Method in class ListDocumentsRequest
- The fields to return. If not set, returns all fields.
- ListDocumentsRequest::getTransaction() — Method in class ListDocumentsRequest
- Reads documents in a transaction.
- ListDocumentsRequest::getReadTime() — Method in class ListDocumentsRequest
- Reads documents as they were at the given time.
- ListDocumentsRequest::getShowMissing() — Method in class ListDocumentsRequest
- If the list should show missing documents. A missing document is a document that does not exist but has sub-documents. These documents will be returned with a key but will not have fields, [Document.create_time][google.firestore.v1beta1.Document.create_time], or [Document.update_time][google.firestore.v1beta1.Document.update_time] set.
- ListDocumentsRequest::getConsistencySelector() — Method in class ListDocumentsRequest
- ListDocumentsResponse::getDocuments() — Method in class ListDocumentsResponse
- The Documents found.
- ListDocumentsResponse::getNextPageToken() — Method in class ListDocumentsResponse
- The next page token.
- ListenRequest::getDatabase() — Method in class ListenRequest
- The database name. In the format:
projects/{project_id}/databases/{database_id}. - ListenRequest::getAddTarget() — Method in class ListenRequest
- A target to add to this stream.
- ListenRequest::getRemoveTarget() — Method in class ListenRequest
- The ID of a target to remove from this stream.
- ListenRequest::getLabels() — Method in class ListenRequest
- Labels associated with this target change.
- ListenRequest::getTargetChange() — Method in class ListenRequest
- ListenResponse::getTargetChange() — Method in class ListenResponse
- Targets have changed.
- ListenResponse::getDocumentChange() — Method in class ListenResponse
- A [Document][google.firestore.v1beta1.Document] has changed.
- ListenResponse::getDocumentDelete() — Method in class ListenResponse
- A [Document][google.firestore.v1beta1.Document] has been deleted.
- ListenResponse::getDocumentRemove() — Method in class ListenResponse
- A [Document][google.firestore.v1beta1.Document] has been removed from a target (because it is no longer relevant to that target).
- ListenResponse::getFilter() — Method in class ListenResponse
- A filter to apply to the set of documents previously returned for the given target.
- ListenResponse::getResponseType() — Method in class ListenResponse
- MapValue::getFields() — Method in class MapValue
- The map's fields.
- Precondition::getExists() — Method in class Precondition
- When set to
true, the target document must exist. - Precondition::getUpdateTime() — Method in class Precondition
- When set, the target document must exist and have been last updated at that time.
- Precondition::getConditionType() — Method in class Precondition
- RollbackRequest::getDatabase() — Method in class RollbackRequest
- The database name. In the format:
projects/{project_id}/databases/{database_id}. - RollbackRequest::getTransaction() — Method in class RollbackRequest
- The transaction to roll back.
- RunQueryRequest::getParent() — Method in class RunQueryRequest
- The parent resource name. In the format:
projects/{project_id}/databases/{database_id}/documentsorprojects/{project_id}/databases/{database_id}/documents/{document_path}. - RunQueryRequest::getStructuredQuery() — Method in class RunQueryRequest
- A structured query.
- RunQueryRequest::getTransaction() — Method in class RunQueryRequest
- Reads documents in a transaction.
- RunQueryRequest::getNewTransaction() — Method in class RunQueryRequest
- Starts a new transaction and reads the documents.
- RunQueryRequest::getReadTime() — Method in class RunQueryRequest
- Reads documents as they were at the given time.
- RunQueryRequest::getQueryType() — Method in class RunQueryRequest
- RunQueryRequest::getConsistencySelector() — Method in class RunQueryRequest
- RunQueryResponse::getTransaction() — Method in class RunQueryResponse
- The transaction that was started as part of this request.
- RunQueryResponse::getDocument() — Method in class RunQueryResponse
- A query result.
- RunQueryResponse::getReadTime() — Method in class RunQueryResponse
- The time at which the document was read. This may be monotonically
increasing; in this case, the previous documents in the result stream are
guaranteed not to have changed between their
read_timeand this one. - RunQueryResponse::getSkippedResults() — Method in class RunQueryResponse
- The number of results that have been skipped due to an offset between the last response and the current response.
- StructuredQuery::getSelect() — Method in class StructuredQuery
- The projection to return.
- StructuredQuery::getFrom() — Method in class StructuredQuery
- The collections to query.
- StructuredQuery::getWhere() — Method in class StructuredQuery
- The filter to apply.
- StructuredQuery::getOrderBy() — Method in class StructuredQuery
- The order to apply to the query results.
- StructuredQuery::getStartAt() — Method in class StructuredQuery
- A starting point for the query results.
- StructuredQuery::getEndAt() — Method in class StructuredQuery
- A end point for the query results.
- StructuredQuery::getOffset() — Method in class StructuredQuery
- The number of results to skip.
- StructuredQuery::getLimit() — Method in class StructuredQuery
- The maximum number of results to return.
- StructuredQuery_CollectionSelector::getCollectionId() — Method in class StructuredQuery_CollectionSelector
- The collection ID.
- StructuredQuery_CollectionSelector::getAllDescendants() — Method in class StructuredQuery_CollectionSelector
- When false, selects only collections that are immediate children of
the
parentspecified in the containingRunQueryRequest. - StructuredQuery_CompositeFilter::getOp() — Method in class StructuredQuery_CompositeFilter
- The operator for combining multiple filters.
- StructuredQuery_CompositeFilter::getFilters() — Method in class StructuredQuery_CompositeFilter
- The list of filters to combine.
- StructuredQuery_FieldFilter::getField() — Method in class StructuredQuery_FieldFilter
- The field to filter by.
- StructuredQuery_FieldFilter::getOp() — Method in class StructuredQuery_FieldFilter
- The operator to filter by.
- StructuredQuery_FieldFilter::getValue() — Method in class StructuredQuery_FieldFilter
- The value to compare to.
- StructuredQuery_FieldReference::getFieldPath() — Method in class StructuredQuery_FieldReference
- Generated from protobuf field
string field_path = 2; - StructuredQuery_Filter::getCompositeFilter() — Method in class StructuredQuery_Filter
- A composite filter.
- StructuredQuery_Filter::getFieldFilter() — Method in class StructuredQuery_Filter
- A filter on a document field.
- StructuredQuery_Filter::getUnaryFilter() — Method in class StructuredQuery_Filter
- A filter that takes exactly one argument.
- StructuredQuery_Filter::getFilterType() — Method in class StructuredQuery_Filter
- StructuredQuery_Order::getField() — Method in class StructuredQuery_Order
- The field to order by.
- StructuredQuery_Order::getDirection() — Method in class StructuredQuery_Order
- The direction to order by. Defaults to
ASCENDING. - StructuredQuery_Projection::getFields() — Method in class StructuredQuery_Projection
- The fields to return.
- StructuredQuery_UnaryFilter::getOp() — Method in class StructuredQuery_UnaryFilter
- The unary operator to apply.
- StructuredQuery_UnaryFilter::getField() — Method in class StructuredQuery_UnaryFilter
- The field to which to apply the operator.
- StructuredQuery_UnaryFilter::getOperandType() — Method in class StructuredQuery_UnaryFilter
- Target::getQuery() — Method in class Target
- A target specified by a query.
- Target::getDocuments() — Method in class Target
- A target specified by a set of document names.
- Target::getResumeToken() — Method in class Target
- A resume token from a prior [TargetChange][google.firestore.v1beta1.TargetChange] for an identical target.
- Target::getReadTime() — Method in class Target
- Start listening after a specific
read_time. - Target::getTargetId() — Method in class Target
- A client provided target ID.
- Target::getOnce() — Method in class Target
- If the target should be removed once it is current and consistent.
- Target::getTargetType() — Method in class Target
- Target::getResumeType() — Method in class Target
- TargetChange::getTargetChangeType() — Method in class TargetChange
- The type of change that occurred.
- TargetChange::getTargetIds() — Method in class TargetChange
- The target IDs of targets that have changed.
- TargetChange::getCause() — Method in class TargetChange
- The error that resulted in this change, if applicable.
- TargetChange::getResumeToken() — Method in class TargetChange
- A token that can be used to resume the stream for the given
target_ids, or all targets iftarget_idsis empty. - TargetChange::getReadTime() — Method in class TargetChange
- The consistent
read_timefor the giventarget_ids(omitted when the target_ids are not at a consistent snapshot). - Target_DocumentsTarget::getDocuments() — Method in class Target_DocumentsTarget
- The names of the documents to retrieve. In the format:
projects/{project_id}/databases/{database_id}/documents/{document_path}. - Target_QueryTarget::getParent() — Method in class Target_QueryTarget
- The parent resource name. In the format:
projects/{project_id}/databases/{database_id}/documentsorprojects/{project_id}/databases/{database_id}/documents/{document_path}. - Target_QueryTarget::getStructuredQuery() — Method in class Target_QueryTarget
- A structured query.
- Target_QueryTarget::getQueryType() — Method in class Target_QueryTarget
- TransactionOptions::getReadOnly() — Method in class TransactionOptions
- The transaction can only be used for read operations.
- TransactionOptions::getReadWrite() — Method in class TransactionOptions
- The transaction can be used for both read and write operations.
- TransactionOptions::getMode() — Method in class TransactionOptions
- TransactionOptions_ReadOnly::getReadTime() — Method in class TransactionOptions_ReadOnly
- Reads documents at the given time.
- TransactionOptions_ReadOnly::getConsistencySelector() — Method in class TransactionOptions_ReadOnly
- TransactionOptions_ReadWrite::getRetryTransaction() — Method in class TransactionOptions_ReadWrite
- An optional transaction to retry.
- UpdateDocumentRequest::getDocument() — Method in class UpdateDocumentRequest
- The updated document.
- UpdateDocumentRequest::getUpdateMask() — Method in class UpdateDocumentRequest
- The fields to update.
- UpdateDocumentRequest::getMask() — Method in class UpdateDocumentRequest
- The fields to return. If not set, returns all fields.
- UpdateDocumentRequest::getCurrentDocument() — Method in class UpdateDocumentRequest
- An optional precondition on the document.
- Value::getNullValue() — Method in class Value
- A null value.
- Value::getBooleanValue() — Method in class Value
- A boolean value.
- Value::getIntegerValue() — Method in class Value
- An integer value.
- Value::getDoubleValue() — Method in class Value
- A double value.
- Value::getTimestampValue() — Method in class Value
- A timestamp value.
- Value::getStringValue() — Method in class Value
- A string value.
- Value::getBytesValue() — Method in class Value
- A bytes value.
- Value::getReferenceValue() — Method in class Value
- A reference to a document. For example:
projects/{project_id}/databases/{database_id}/documents/{document_path}. - Value::getGeoPointValue() — Method in class Value
- A geo point value representing a point on the surface of Earth.
- Value::getArrayValue() — Method in class Value
- An array value.
- Value::getMapValue() — Method in class Value
- A map value.
- Value::getValueType() — Method in class Value
- Write::getUpdate() — Method in class Write
- A document to write.
- Write::getDelete() — Method in class Write
- A document name to delete. In the format:
projects/{project_id}/databases/{database_id}/documents/{document_path}. - Write::getTransform() — Method in class Write
- Applies a tranformation to a document.
- Write::getUpdateMask() — Method in class Write
- The fields to update in this write.
- Write::getCurrentDocument() — Method in class Write
- An optional precondition on the document.
- Write::getOperation() — Method in class Write
- WriteRequest::getDatabase() — Method in class WriteRequest
- The database name. In the format:
projects/{project_id}/databases/{database_id}. - WriteRequest::getStreamId() — Method in class WriteRequest
- The ID of the write stream to resume.
- WriteRequest::getWrites() — Method in class WriteRequest
- The writes to apply.
- WriteRequest::getStreamToken() — Method in class WriteRequest
- A stream token that was previously sent by the server.
- WriteRequest::getLabels() — Method in class WriteRequest
- Labels associated with this write request.
- WriteResponse::getStreamId() — Method in class WriteResponse
- The ID of the stream.
- WriteResponse::getStreamToken() — Method in class WriteResponse
- A token that represents the position of this response in the stream.
- WriteResponse::getWriteResults() — Method in class WriteResponse
- The result of applying the writes.
- WriteResponse::getCommitTime() — Method in class WriteResponse
- The time at which the commit occurred.
- WriteResult::getUpdateTime() — Method in class WriteResult
- The last update time of the document after applying the write. Not set
after a
delete. - WriteResult::getTransformResults() — Method in class WriteResult
- The results of applying each [DocumentTransform.FieldTransform][google.firestore.v1beta1.DocumentTransform.FieldTransform], in the same order.
- Binding::getRole() — Method in class Binding
- Role that is assigned to
members. - Binding::getMembers() — Method in class Binding
- Specifies the identities requesting access for a Cloud Platform resource.
- BindingDelta::getAction() — Method in class BindingDelta
- The action that was performed on a Binding.
- BindingDelta::getRole() — Method in class BindingDelta
- Role that is assigned to
members. - BindingDelta::getMember() — Method in class BindingDelta
- A single identity requesting access for a Cloud Platform resource.
- GetIamPolicyRequest — Class in namespace Google\Cloud\Iam\V1
- Request message for
GetIamPolicymethod. - GetIamPolicyRequest::getResource() — Method in class GetIamPolicyRequest
- REQUIRED: The resource for which the policy is being requested.
- IAMPolicyGrpcClient::GetIamPolicy() — Method in class IAMPolicyGrpcClient
- Gets the access control policy for a resource.
- Policy::getVersion() — Method in class Policy
- Version of the
Policy. The default version is 0. - Policy::getBindings() — Method in class Policy
- Associates a list of
membersto arole. - Policy::getEtag() — Method in class Policy
etagis used for optimistic concurrency control as a way to help prevent simultaneous updates of a policy from overwriting each other.- PolicyDelta::getBindingDeltas() — Method in class PolicyDelta
- The delta for Bindings between two policies.
- SetIamPolicyRequest::getResource() — Method in class SetIamPolicyRequest
- REQUIRED: The resource for which the policy is being specified.
- SetIamPolicyRequest::getPolicy() — Method in class SetIamPolicyRequest
- REQUIRED: The complete policy to be applied to the
resource. The size of the policy is limited to a few 10s of KB. An empty policy is a valid policy but certain Cloud Platform services (such as Projects) might reject them. - TestIamPermissionsRequest::getResource() — Method in class TestIamPermissionsRequest
- REQUIRED: The resource for which the policy detail is being requested.
- TestIamPermissionsRequest::getPermissions() — Method in class TestIamPermissionsRequest
- The set of permissions to check for the
resource. Permissions with wildcards (such as '' or 'storage.') are not allowed. For more information see IAM Overview. - TestIamPermissionsResponse::getPermissions() — Method in class TestIamPermissionsResponse
- A subset of
TestPermissionsRequest.permissionsthat the caller is allowed. - CreateDeviceRegistryRequest::getParent() — Method in class CreateDeviceRegistryRequest
- The project and cloud region where this device registry must be created.
- CreateDeviceRegistryRequest::getDeviceRegistry() — Method in class CreateDeviceRegistryRequest
- The device registry. The field
namemust be empty. The server will generate that field from the device registryidprovided and theparentfield. - CreateDeviceRequest::getParent() — Method in class CreateDeviceRequest
- The name of the device registry where this device should be created.
- CreateDeviceRequest::getDevice() — Method in class CreateDeviceRequest
- The device registration details. The field
namemust be empty. The server will generate that field from the device registryidprovided and theparentfield. - DeleteDeviceRegistryRequest::getName() — Method in class DeleteDeviceRegistryRequest
- The name of the device registry. For example,
projects/example-project/locations/us-central1/registries/my-registry. - DeleteDeviceRequest::getName() — Method in class DeleteDeviceRequest
- The name of the device. For example,
projects/p0/locations/us-central1/registries/registry0/devices/device0orprojects/p0/locations/us-central1/registries/registry0/devices/{num_id}. - Device::getId() — Method in class Device
- The user-defined device identifier. The device ID must be unique within a device registry.
- Device::getName() — Method in class Device
- The resource path name. For example,
projects/p1/locations/us-central1/registries/registry0/devices/dev0orprojects/p1/locations/us-central1/registries/registry0/devices/{num_id}. - Device::getNumId() — Method in class Device
- [Output only] A server-defined unique numeric ID for the device. This is a more compact way to identify devices, and it is globally unique.
- Device::getCredentials() — Method in class Device
- The credentials used to authenticate this device. To allow credential
rotation without interruption, multiple device credentials can be bound to
this device. No more than 3 credentials can be bound to a single device at
a time. When new credentials are added to a device, they are verified
against the registry credentials. For details, see the description of the
DeviceRegistry.credentialsfield. - Device::getLastHeartbeatTime() — Method in class Device
- [Output only] The last time an MQTT
PINGREQwas received. This field applies only to devices connecting through MQTT. MQTT clients usually only sendPINGREQmessages if the connection is idle, and no other messages have been sent. Timestamps are periodically collected and written to storage; they may be stale by a few minutes. - Device::getLastEventTime() — Method in class Device
- [Output only] The last time a telemetry event was received. Timestamps are periodically collected and written to storage; they may be stale by a few minutes.
- Device::getLastStateTime() — Method in class Device
- [Output only] The last time a state event was received. Timestamps are periodically collected and written to storage; they may be stale by a few minutes.
- Device::getLastConfigAckTime() — Method in class Device
- [Output only] The last time a cloud-to-device config version acknowledgment was received from the device. This field is only for configurations sent through MQTT.
- Device::getLastConfigSendTime() — Method in class Device
- [Output only] The last time a cloud-to-device config version was sent to the device.
- Device::getBlocked() — Method in class Device
- If a device is blocked, connections or requests from this device will fail.
- Device::getLastErrorTime() — Method in class Device
- [Output only] The time the most recent error occurred, such as a failure to publish to Cloud Pub/Sub. This field is the timestamp of 'last_error_status'.
- Device::getLastErrorStatus() — Method in class Device
- [Output only] The error message of the most recent error, such as a failure to publish to Cloud Pub/Sub. 'last_error_time' is the timestamp of this field. If no errors have occurred, this field has an empty message and the status code 0 == OK. Otherwise, this field is expected to have a status code other than OK.
- Device::getConfig() — Method in class Device
- The most recent device configuration, which is eventually sent from
Cloud IoT Core to the device. If not present on creation, the
configuration will be initialized with an empty payload and version value
of
1. To update this field after creation, use theDeviceManager.ModifyCloudToDeviceConfigmethod. - Device::getState() — Method in class Device
- [Output only] The state most recently received from the device. If no state has been reported, this field is not present.
- Device::getMetadata() — Method in class Device
- The metadata key-value pairs assigned to the device. This metadata is not interpreted or indexed by Cloud IoT Core. It can be used to add contextual information for the device.
- DeviceConfig::getVersion() — Method in class DeviceConfig
- [Output only] The version of this update. The version number is assigned by
the server, and is always greater than 0 after device creation. The
version must be 0 on the
CreateDevicerequest if aconfigis specified; the response ofCreateDevicewill always have a value of 1. - DeviceConfig::getCloudUpdateTime() — Method in class DeviceConfig
- [Output only] The time at which this configuration version was updated in Cloud IoT Core. This timestamp is set by the server.
- DeviceConfig::getDeviceAckTime() — Method in class DeviceConfig
- [Output only] The time at which Cloud IoT Core received the acknowledgment from the device, indicating that the device has received this configuration version. If this field is not present, the device has not yet acknowledged that it received this version. Note that when the config was sent to the device, many config versions may have been available in Cloud IoT Core while the device was disconnected, and on connection, only the latest version is sent to the device. Some versions may never be sent to the device, and therefore are never acknowledged. This timestamp is set by Cloud IoT Core.
- DeviceConfig::getBinaryData() — Method in class DeviceConfig
- The device configuration data.
- DeviceCredential::getPublicKey() — Method in class DeviceCredential
- A public key used to verify the signature of JSON Web Tokens (JWTs).
- DeviceCredential::getExpirationTime() — Method in class DeviceCredential
- [Optional] The time at which this credential becomes invalid. This credential will be ignored for new client authentication requests after this timestamp; however, it will not be automatically deleted.
- DeviceCredential::getCredential() — Method in class DeviceCredential
- DeviceManagerGrpcClient::GetDeviceRegistry() — Method in class DeviceManagerGrpcClient
- Gets a device registry configuration.
- DeviceManagerGrpcClient::GetDevice() — Method in class DeviceManagerGrpcClient
- Gets details about a device.
- DeviceManagerGrpcClient::GetIamPolicy() — Method in class DeviceManagerGrpcClient
- Gets the access control policy for a resource.
- DeviceRegistry::getId() — Method in class DeviceRegistry
- The identifier of this device registry. For example,
myRegistry. - DeviceRegistry::getName() — Method in class DeviceRegistry
- The resource path name. For example,
projects/example-project/locations/us-central1/registries/my-registry. - DeviceRegistry::getEventNotificationConfigs() — Method in class DeviceRegistry
- The configuration for notification of telemetry events received from the device. All telemetry events that were successfully published by the device and acknowledged by Cloud IoT Core are guaranteed to be delivered to Cloud Pub/Sub. If multiple configurations match a message, only the first matching configuration is used. If you try to publish a device telemetry event using MQTT without specifying a Cloud Pub/Sub topic for the device's registry, the connection closes automatically. If you try to do so using an HTTP connection, an error is returned. Up to 10 configurations may be provided.
- DeviceRegistry::getStateNotificationConfig() — Method in class DeviceRegistry
- The configuration for notification of new states received from the device.
- DeviceRegistry::getMqttConfig() — Method in class DeviceRegistry
- The MQTT configuration for this device registry.
- DeviceRegistry::getHttpConfig() — Method in class DeviceRegistry
- The DeviceService (HTTP) configuration for this device registry.
- DeviceRegistry::getCredentials() — Method in class DeviceRegistry
- The credentials used to verify the device credentials. No more than 10 credentials can be bound to a single registry at a time. The verification process occurs at the time of device creation or update. If this field is empty, no verification is performed. Otherwise, the credentials of a newly created device or added credentials of an updated device should be signed with one of these registry credentials.
- DeviceState::getUpdateTime() — Method in class DeviceState
- [Output only] The time at which this state version was updated in Cloud IoT Core.
- DeviceState::getBinaryData() — Method in class DeviceState
- The device state data.
- EventNotificationConfig::getSubfolderMatches() — Method in class EventNotificationConfig
- If the subfolder name matches this string exactly, this configuration will be used. The string must not include the leading '/' character. If empty, all strings are matched. This field is used only for telemetry events; subfolders are not supported for state changes.
- EventNotificationConfig::getPubsubTopicName() — Method in class EventNotificationConfig
- A Cloud Pub/Sub topic name. For example,
projects/myProject/topics/deviceEvents. - GetDeviceRegistryRequest — Class in namespace Google\Cloud\Iot\V1
- Request for
GetDeviceRegistry. - GetDeviceRegistryRequest::getName() — Method in class GetDeviceRegistryRequest
- The name of the device registry. For example,
projects/example-project/locations/us-central1/registries/my-registry. - GetDeviceRequest — Class in namespace Google\Cloud\Iot\V1
- Request for
GetDevice. - GetDeviceRequest::getName() — Method in class GetDeviceRequest
- The name of the device. For example,
projects/p0/locations/us-central1/registries/registry0/devices/device0orprojects/p0/locations/us-central1/registries/registry0/devices/{num_id}. - GetDeviceRequest::getFieldMask() — Method in class GetDeviceRequest
- The fields of the
Deviceresource to be returned in the response. If the field mask is unset or empty, all fields are returned. - HttpConfig::getHttpEnabledState() — Method in class HttpConfig
- If enabled, allows devices to use DeviceService via the HTTP protocol.
- ListDeviceConfigVersionsRequest::getName() — Method in class ListDeviceConfigVersionsRequest
- The name of the device. For example,
projects/p0/locations/us-central1/registries/registry0/devices/device0orprojects/p0/locations/us-central1/registries/registry0/devices/{num_id}. - ListDeviceConfigVersionsRequest::getNumVersions() — Method in class ListDeviceConfigVersionsRequest
- The number of versions to list. Versions are listed in decreasing order of the version number. The maximum number of versions retained is 10. If this value is zero, it will return all the versions available.
- ListDeviceConfigVersionsResponse::getDeviceConfigs() — Method in class ListDeviceConfigVersionsResponse
- The device configuration for the last few versions. Versions are listed in decreasing order, starting from the most recent one.
- ListDeviceRegistriesRequest::getParent() — Method in class ListDeviceRegistriesRequest
- The project and cloud region path. For example,
projects/example-project/locations/us-central1. - ListDeviceRegistriesRequest::getPageSize() — Method in class ListDeviceRegistriesRequest
- The maximum number of registries to return in the response. If this value
is zero, the service will select a default size. A call may return fewer
objects than requested, but if there is a non-empty
page_token, it indicates that more entries are available. - ListDeviceRegistriesRequest::getPageToken() — Method in class ListDeviceRegistriesRequest
- The value returned by the last
ListDeviceRegistriesResponse; indicates that this is a continuation of a priorListDeviceRegistriescall, and that the system should return the next page of data. - ListDeviceRegistriesResponse::getDeviceRegistries() — Method in class ListDeviceRegistriesResponse
- The registries that matched the query.
- ListDeviceRegistriesResponse::getNextPageToken() — Method in class ListDeviceRegistriesResponse
- If not empty, indicates that there may be more registries that match the
request; this value should be passed in a new
ListDeviceRegistriesRequest. - ListDeviceStatesRequest::getName() — Method in class ListDeviceStatesRequest
- The name of the device. For example,
projects/p0/locations/us-central1/registries/registry0/devices/device0orprojects/p0/locations/us-central1/registries/registry0/devices/{num_id}. - ListDeviceStatesRequest::getNumStates() — Method in class ListDeviceStatesRequest
- The number of states to list. States are listed in descending order of update time. The maximum number of states retained is 10. If this value is zero, it will return all the states available.
- ListDeviceStatesResponse::getDeviceStates() — Method in class ListDeviceStatesResponse
- The last few device states. States are listed in descending order of server update time, starting from the most recent one.
- ListDevicesRequest::getParent() — Method in class ListDevicesRequest
- The device registry path. Required. For example,
projects/my-project/locations/us-central1/registries/my-registry. - ListDevicesRequest::getDeviceNumIds() — Method in class ListDevicesRequest
- A list of device numerical ids. If empty, it will ignore this field. This field cannot hold more than 10,000 entries.
- ListDevicesRequest::getDeviceIds() — Method in class ListDevicesRequest
- A list of device string identifiers. If empty, it will ignore this field.
- ListDevicesRequest::getFieldMask() — Method in class ListDevicesRequest
- The fields of the
Deviceresource to be returned in the response. The fieldsid, andnum_idare always returned by default, along with any other fields specified. - ListDevicesRequest::getPageSize() — Method in class ListDevicesRequest
- The maximum number of devices to return in the response. If this value
is zero, the service will select a default size. A call may return fewer
objects than requested, but if there is a non-empty
page_token, it indicates that more entries are available. - ListDevicesRequest::getPageToken() — Method in class ListDevicesRequest
- The value returned by the last
ListDevicesResponse; indicates that this is a continuation of a priorListDevicescall, and that the system should return the next page of data. - ListDevicesResponse::getDevices() — Method in class ListDevicesResponse
- The devices that match the request.
- ListDevicesResponse::getNextPageToken() — Method in class ListDevicesResponse
- If not empty, indicates that there may be more devices that match the
request; this value should be passed in a new
ListDevicesRequest. - ModifyCloudToDeviceConfigRequest::getName() — Method in class ModifyCloudToDeviceConfigRequest
- The name of the device. For example,
projects/p0/locations/us-central1/registries/registry0/devices/device0orprojects/p0/locations/us-central1/registries/registry0/devices/{num_id}. - ModifyCloudToDeviceConfigRequest::getVersionToUpdate() — Method in class ModifyCloudToDeviceConfigRequest
- The version number to update. If this value is zero, it will not check the version number of the server and will always update the current version; otherwise, this update will fail if the version number found on the server does not match this version number. This is used to support multiple simultaneous updates without losing data.
- ModifyCloudToDeviceConfigRequest::getBinaryData() — Method in class ModifyCloudToDeviceConfigRequest
- The configuration data for the device.
- MqttConfig::getMqttEnabledState() — Method in class MqttConfig
- If enabled, allows connections using the MQTT protocol. Otherwise, MQTT connections to this registry will fail.
- PublicKeyCertificate::getFormat() — Method in class PublicKeyCertificate
- The certificate format.
- PublicKeyCertificate::getCertificate() — Method in class PublicKeyCertificate
- The certificate data.
- PublicKeyCertificate::getX509Details() — Method in class PublicKeyCertificate
- [Output only] The certificate details. Used only for X.509 certificates.
- PublicKeyCredential::getFormat() — Method in class PublicKeyCredential
- The format of the key.
- PublicKeyCredential::getKey() — Method in class PublicKeyCredential
- The key data.
- RegistryCredential::getPublicKeyCertificate() — Method in class RegistryCredential
- A public key certificate used to verify the device credentials.
- RegistryCredential::getCredential() — Method in class RegistryCredential
- StateNotificationConfig::getPubsubTopicName() — Method in class StateNotificationConfig
- A Cloud Pub/Sub topic name. For example,
projects/myProject/topics/deviceEvents. - UpdateDeviceRegistryRequest::getDeviceRegistry() — Method in class UpdateDeviceRegistryRequest
- The new values for the device registry. The
idfield must be empty, and thenamefield must indicate the path of the resource. For example,projects/example-project/locations/us-central1/registries/my-registry. - UpdateDeviceRegistryRequest::getUpdateMask() — Method in class UpdateDeviceRegistryRequest
- Only updates the
device_registryfields indicated by this mask. - UpdateDeviceRequest::getDevice() — Method in class UpdateDeviceRequest
- The new values for the device registry. The
idandnum_idfields must be empty, and the fieldnamemust specify the name path. For example,projects/p0/locations/us-central1/registries/registry0/devices/device0orprojects/p0/locations/us-central1/registries/registry0/devices/{num_id}. - UpdateDeviceRequest::getUpdateMask() — Method in class UpdateDeviceRequest
- Only updates the
devicefields indicated by this mask. - X509CertificateDetails::getIssuer() — Method in class X509CertificateDetails
- The entity that signed the certificate.
- X509CertificateDetails::getSubject() — Method in class X509CertificateDetails
- The entity the certificate and public key belong to.
- X509CertificateDetails::getStartTime() — Method in class X509CertificateDetails
- The time the certificate becomes valid.
- X509CertificateDetails::getExpiryTime() — Method in class X509CertificateDetails
- The time the certificate becomes invalid.
- X509CertificateDetails::getSignatureAlgorithm() — Method in class X509CertificateDetails
- The algorithm used to sign the certificate.
- X509CertificateDetails::getPublicKeyType() — Method in class X509CertificateDetails
- The type of public key in the certificate.
- AnalyzeEntitiesRequest::getDocument() — Method in class AnalyzeEntitiesRequest
- Input document.
- AnalyzeEntitiesRequest::getEncodingType() — Method in class AnalyzeEntitiesRequest
- The encoding type used by the API to calculate offsets.
- AnalyzeEntitiesResponse::getEntities() — Method in class AnalyzeEntitiesResponse
- The recognized entities in the input document.
- AnalyzeEntitiesResponse::getLanguage() — Method in class AnalyzeEntitiesResponse
- The language of the text, which will be the same as the language specified in the request or, if not specified, the automatically-detected language.
- AnalyzeEntitySentimentRequest::getDocument() — Method in class AnalyzeEntitySentimentRequest
- Input document.
- AnalyzeEntitySentimentRequest::getEncodingType() — Method in class AnalyzeEntitySentimentRequest
- The encoding type used by the API to calculate offsets.
- AnalyzeEntitySentimentResponse::getEntities() — Method in class AnalyzeEntitySentimentResponse
- The recognized entities in the input document with associated sentiments.
- AnalyzeEntitySentimentResponse::getLanguage() — Method in class AnalyzeEntitySentimentResponse
- The language of the text, which will be the same as the language specified in the request or, if not specified, the automatically-detected language.
- AnalyzeSentimentRequest::getDocument() — Method in class AnalyzeSentimentRequest
- Input document.
- AnalyzeSentimentRequest::getEncodingType() — Method in class AnalyzeSentimentRequest
- The encoding type used by the API to calculate sentence offsets for the sentence sentiment.
- AnalyzeSentimentResponse::getDocumentSentiment() — Method in class AnalyzeSentimentResponse
- The overall sentiment of the input document.
- AnalyzeSentimentResponse::getLanguage() — Method in class AnalyzeSentimentResponse
- The language of the text, which will be the same as the language specified in the request or, if not specified, the automatically-detected language.
- AnalyzeSentimentResponse::getSentences() — Method in class AnalyzeSentimentResponse
- The sentiment for all the sentences in the document.
- AnalyzeSyntaxRequest::getDocument() — Method in class AnalyzeSyntaxRequest
- Input document.
- AnalyzeSyntaxRequest::getEncodingType() — Method in class AnalyzeSyntaxRequest
- The encoding type used by the API to calculate offsets.
- AnalyzeSyntaxResponse::getSentences() — Method in class AnalyzeSyntaxResponse
- Sentences in the input document.
- AnalyzeSyntaxResponse::getTokens() — Method in class AnalyzeSyntaxResponse
- Tokens, along with their syntactic information, in the input document.
- AnalyzeSyntaxResponse::getLanguage() — Method in class AnalyzeSyntaxResponse
- The language of the text, which will be the same as the language specified in the request or, if not specified, the automatically-detected language.
- AnnotateTextRequest::getDocument() — Method in class AnnotateTextRequest
- Input document.
- AnnotateTextRequest::getFeatures() — Method in class AnnotateTextRequest
- The enabled features.
- AnnotateTextRequest::getEncodingType() — Method in class AnnotateTextRequest
- The encoding type used by the API to calculate offsets.
- AnnotateTextRequest_Features::getExtractSyntax() — Method in class AnnotateTextRequest_Features
- Extract syntax information.
- AnnotateTextRequest_Features::getExtractEntities() — Method in class AnnotateTextRequest_Features
- Extract entities.
- AnnotateTextRequest_Features::getExtractDocumentSentiment() — Method in class AnnotateTextRequest_Features
- Extract document-level sentiment.
- AnnotateTextRequest_Features::getExtractEntitySentiment() — Method in class AnnotateTextRequest_Features
- Extract entities and their associated sentiment.
- AnnotateTextRequest_Features::getClassifyText() — Method in class AnnotateTextRequest_Features
- Classify the full document into categories.
- AnnotateTextResponse::getSentences() — Method in class AnnotateTextResponse
- Sentences in the input document. Populated if the user enables [AnnotateTextRequest.Features.extract_syntax][google.cloud.language.v1beta2.AnnotateTextRequest.Features.extract_syntax].
- AnnotateTextResponse::getTokens() — Method in class AnnotateTextResponse
- Tokens, along with their syntactic information, in the input document.
- AnnotateTextResponse::getEntities() — Method in class AnnotateTextResponse
- Entities, along with their semantic information, in the input document.
- AnnotateTextResponse::getDocumentSentiment() — Method in class AnnotateTextResponse
- The overall sentiment for the document. Populated if the user enables [AnnotateTextRequest.Features.extract_document_sentiment][google.cloud.language.v1beta2.AnnotateTextRequest.Features.extract_document_sentiment].
- AnnotateTextResponse::getLanguage() — Method in class AnnotateTextResponse
- The language of the text, which will be the same as the language specified in the request or, if not specified, the automatically-detected language.
- AnnotateTextResponse::getCategories() — Method in class AnnotateTextResponse
- Categories identified in the input document.
- ClassificationCategory::getName() — Method in class ClassificationCategory
- The name of the category representing the document.
- ClassificationCategory::getConfidence() — Method in class ClassificationCategory
- The classifier's confidence of the category. Number represents how certain the classifier is that this category represents the given text.
- ClassifyTextRequest::getDocument() — Method in class ClassifyTextRequest
- Input document.
- ClassifyTextResponse::getCategories() — Method in class ClassifyTextResponse
- Categories representing the input document.
- DependencyEdge::getHeadTokenIndex() — Method in class DependencyEdge
- Represents the head of this token in the dependency tree.
- DependencyEdge::getLabel() — Method in class DependencyEdge
- The parse label for the token.
- Document::getType() — Method in class Document
- Required. If the type is not set or is
TYPE_UNSPECIFIED, returns anINVALID_ARGUMENTerror. - Document::getContent() — Method in class Document
- The content of the input in string format.
- Document::getGcsContentUri() — Method in class Document
- The Google Cloud Storage URI where the file content is located.
- Document::getLanguage() — Method in class Document
- The language of the document (if not specified, the language is
automatically detected). Both ISO and BCP-47 language codes are
accepted.
Language Support lists currently supported languages for each API method. - Document::getSource() — Method in class Document
- Entity::getName() — Method in class Entity
- The representative name for the entity.
- Entity::getType() — Method in class Entity
- The entity type.
- Entity::getMetadata() — Method in class Entity
- Metadata associated with the entity.
- Entity::getSalience() — Method in class Entity
- The salience score associated with the entity in the [0, 1.0] range.
- Entity::getMentions() — Method in class Entity
- The mentions of this entity in the input document. The API currently supports proper noun mentions.
- Entity::getSentiment() — Method in class Entity
- For calls to [AnalyzeEntitySentiment][] or if [AnnotateTextRequest.Features.extract_entity_sentiment][google.cloud.language.v1beta2.AnnotateTextRequest.Features.extract_entity_sentiment] is set to true, this field will contain the aggregate sentiment expressed for this entity in the provided document.
- EntityMention::getText() — Method in class EntityMention
- The mention text.
- EntityMention::getType() — Method in class EntityMention
- The type of the entity mention.
- EntityMention::getSentiment() — Method in class EntityMention
- For calls to [AnalyzeEntitySentiment][] or if [AnnotateTextRequest.Features.extract_entity_sentiment][google.cloud.language.v1beta2.AnnotateTextRequest.Features.extract_entity_sentiment] is set to true, this field will contain the sentiment expressed for this mention of the entity in the provided document.
- PartOfSpeech::getTag() — Method in class PartOfSpeech
- The part of speech tag.
- PartOfSpeech::getAspect() — Method in class PartOfSpeech
- The grammatical aspect.
- PartOfSpeech::getCase() — Method in class PartOfSpeech
- The grammatical case.
- PartOfSpeech::getForm() — Method in class PartOfSpeech
- The grammatical form.
- PartOfSpeech::getGender() — Method in class PartOfSpeech
- The grammatical gender.
- PartOfSpeech::getMood() — Method in class PartOfSpeech
- The grammatical mood.
- PartOfSpeech::getNumber() — Method in class PartOfSpeech
- The grammatical number.
- PartOfSpeech::getPerson() — Method in class PartOfSpeech
- The grammatical person.
- PartOfSpeech::getProper() — Method in class PartOfSpeech
- The grammatical properness.
- PartOfSpeech::getReciprocity() — Method in class PartOfSpeech
- The grammatical reciprocity.
- PartOfSpeech::getTense() — Method in class PartOfSpeech
- The grammatical tense.
- PartOfSpeech::getVoice() — Method in class PartOfSpeech
- The grammatical voice.
- Sentence::getText() — Method in class Sentence
- The sentence text.
- Sentence::getSentiment() — Method in class Sentence
- For calls to [AnalyzeSentiment][] or if [AnnotateTextRequest.Features.extract_document_sentiment][google.cloud.language.v1beta2.AnnotateTextRequest.Features.extract_document_sentiment] is set to true, this field will contain the sentiment for the sentence.
- Sentiment::getMagnitude() — Method in class Sentiment
- A non-negative number in the [0, +inf) range, which represents the absolute magnitude of sentiment regardless of score (positive or negative).
- Sentiment::getScore() — Method in class Sentiment
- Sentiment score between -1.0 (negative sentiment) and 1.0 (positive sentiment).
- TextSpan::getContent() — Method in class TextSpan
- The content of the output text.
- TextSpan::getBeginOffset() — Method in class TextSpan
- The API calculates the beginning offset of the content in the original document according to the [EncodingType][google.cloud.language.v1beta2.EncodingType] specified in the API request.
- Token::getText() — Method in class Token
- The token text.
- Token::getPartOfSpeech() — Method in class Token
- Parts of speech tag for this token.
- Token::getDependencyEdge() — Method in class Token
- Dependency tree parse for this token.
- Token::getLemma() — Method in class Token
- Lemma of the token.
- HttpRequest::getRequestMethod() — Method in class HttpRequest
- The request method. Examples:
"GET","HEAD","PUT","POST". - HttpRequest::getRequestUrl() — Method in class HttpRequest
- The scheme (http, https), the host name, the path and the query portion of the URL that was requested.
- HttpRequest::getRequestSize() — Method in class HttpRequest
- The size of the HTTP request message in bytes, including the request headers and the request body.
- HttpRequest::getStatus() — Method in class HttpRequest
- The response code indicating the status of response.
- HttpRequest::getResponseSize() — Method in class HttpRequest
- The size of the HTTP response message sent back to the client, in bytes, including the response headers and the response body.
- HttpRequest::getUserAgent() — Method in class HttpRequest
- The user agent sent by the client. Example:
"Mozilla/4.0 (compatible; MSIE 6.0; Windows 98; Q312461; .NET CLR 1.0.3705)". - HttpRequest::getRemoteIp() — Method in class HttpRequest
- The IP address (IPv4 or IPv6) of the client that issued the HTTP
request. Examples:
"192.168.1.1","FE80::0202:B3FF:FE1E:8329". - HttpRequest::getServerIp() — Method in class HttpRequest
- The IP address (IPv4 or IPv6) of the origin server that the request was sent to.
- HttpRequest::getReferer() — Method in class HttpRequest
- The referer URL of the request, as defined in HTTP/1.1 Header Field Definitions.
- HttpRequest::getLatency() — Method in class HttpRequest
- The request processing latency on the server, from the time the request was received until the response was sent.
- HttpRequest::getCacheLookup() — Method in class HttpRequest
- Whether or not a cache lookup was attempted.
- HttpRequest::getCacheHit() — Method in class HttpRequest
- Whether or not an entity was served from cache (with or without validation).
- HttpRequest::getCacheValidatedWithOriginServer() — Method in class HttpRequest
- Whether or not the response was validated with the origin server before
being served from cache. This field is only meaningful if
cache_hitis True. - HttpRequest::getCacheFillBytes() — Method in class HttpRequest
- The number of HTTP response bytes inserted into cache. Set only when a cache fill was attempted.
- HttpRequest::getProtocol() — Method in class HttpRequest
- Protocol used for the request. Examples: "HTTP/1.1", "HTTP/2", "websocket"
- ConfigServiceV2GrpcClient::GetSink() — Method in class ConfigServiceV2GrpcClient
- Gets a sink.
- ConfigServiceV2GrpcClient::GetExclusion() — Method in class ConfigServiceV2GrpcClient
- Gets the description of an exclusion.
- CreateExclusionRequest::getParent() — Method in class CreateExclusionRequest
- Required. The parent resource in which to create the exclusion:
"projects/[PROJECT_ID]"
"organizations/[ORGANIZATION_ID]"
"billingAccounts/[BILLING_ACCOUNT_ID]"
"folders/[FOLDER_ID]"
Examples:
"projects/my-logging-project","organizations/123456789". - CreateExclusionRequest::getExclusion() — Method in class CreateExclusionRequest
- Required. The new exclusion, whose
nameparameter is an exclusion name that is not already used in the parent resource. - CreateLogMetricRequest::getParent() — Method in class CreateLogMetricRequest
- The resource name of the project in which to create the metric: "projects/[PROJECT_ID]" The new metric must be provided in the request.
- CreateLogMetricRequest::getMetric() — Method in class CreateLogMetricRequest
- The new logs-based metric, which must not have an identifier that already exists.
- CreateSinkRequest::getParent() — Method in class CreateSinkRequest
- Required. The resource in which to create the sink:
"projects/[PROJECT_ID]"
"organizations/[ORGANIZATION_ID]"
"billingAccounts/[BILLING_ACCOUNT_ID]"
"folders/[FOLDER_ID]"
Examples:
"projects/my-logging-project","organizations/123456789". - CreateSinkRequest::getSink() — Method in class CreateSinkRequest
- Required. The new sink, whose
nameparameter is a sink identifier that is not already in use. - CreateSinkRequest::getUniqueWriterIdentity() — Method in class CreateSinkRequest
- Optional. Determines the kind of IAM identity returned as
writer_identityin the new sink. If this value is omitted or set to false, and if the sink's parent is a project, then the value returned aswriter_identityis the same group or service account used by Stackdriver Logging before the addition of writer identities to this API. The sink's destination must be in the same project as the sink itself. - DeleteExclusionRequest::getName() — Method in class DeleteExclusionRequest
- Required. The resource name of an existing exclusion to delete:
"projects/[PROJECT_ID]/exclusions/[EXCLUSION_ID]"
"organizations/[ORGANIZATION_ID]/exclusions/[EXCLUSION_ID]"
"billingAccounts/[BILLING_ACCOUNT_ID]/exclusions/[EXCLUSION_ID]"
"folders/[FOLDER_ID]/exclusions/[EXCLUSION_ID]"
Example:
"projects/my-project-id/exclusions/my-exclusion-id". - DeleteLogMetricRequest::getMetricName() — Method in class DeleteLogMetricRequest
- The resource name of the metric to delete: "projects/[PROJECT_ID]/metrics/[METRIC_ID]"
- DeleteLogRequest::getLogName() — Method in class DeleteLogRequest
- Required. The resource name of the log to delete:
"projects/[PROJECT_ID]/logs/[LOG_ID]"
"organizations/[ORGANIZATION_ID]/logs/[LOG_ID]"
"billingAccounts/[BILLING_ACCOUNT_ID]/logs/[LOG_ID]"
"folders/[FOLDER_ID]/logs/[LOG_ID]"
[LOG_ID]must be URL-encoded. For example,"projects/my-project-id/logs/syslog","organizations/1234567890/logs/cloudresourcemanager.googleapis.com%2Factivity". - DeleteSinkRequest::getSinkName() — Method in class DeleteSinkRequest
- Required. The full resource name of the sink to delete, including the
parent resource and the sink identifier:
"projects/[PROJECT_ID]/sinks/[SINK_ID]"
"organizations/[ORGANIZATION_ID]/sinks/[SINK_ID]"
"billingAccounts/[BILLING_ACCOUNT_ID]/sinks/[SINK_ID]"
"folders/[FOLDER_ID]/sinks/[SINK_ID]"
Example:
"projects/my-project-id/sinks/my-sink-id". - GetExclusionRequest — Class in namespace Google\Cloud\Logging\V2
- The parameters to
GetExclusion. - GetExclusionRequest::getName() — Method in class GetExclusionRequest
- Required. The resource name of an existing exclusion:
"projects/[PROJECT_ID]/exclusions/[EXCLUSION_ID]"
"organizations/[ORGANIZATION_ID]/exclusions/[EXCLUSION_ID]"
"billingAccounts/[BILLING_ACCOUNT_ID]/exclusions/[EXCLUSION_ID]"
"folders/[FOLDER_ID]/exclusions/[EXCLUSION_ID]"
Example:
"projects/my-project-id/exclusions/my-exclusion-id". - GetLogMetricRequest — Class in namespace Google\Cloud\Logging\V2
- The parameters to GetLogMetric.
- GetLogMetricRequest::getMetricName() — Method in class GetLogMetricRequest
- The resource name of the desired metric: "projects/[PROJECT_ID]/metrics/[METRIC_ID]"
- GetSinkRequest — Class in namespace Google\Cloud\Logging\V2
- The parameters to
GetSink. - GetSinkRequest::getSinkName() — Method in class GetSinkRequest
- Required. The resource name of the sink:
"projects/[PROJECT_ID]/sinks/[SINK_ID]"
"organizations/[ORGANIZATION_ID]/sinks/[SINK_ID]"
"billingAccounts/[BILLING_ACCOUNT_ID]/sinks/[SINK_ID]"
"folders/[FOLDER_ID]/sinks/[SINK_ID]"
Example:
"projects/my-project-id/sinks/my-sink-id". - ListExclusionsRequest::getParent() — Method in class ListExclusionsRequest
- Required. The parent resource whose exclusions are to be listed.
- ListExclusionsRequest::getPageToken() — Method in class ListExclusionsRequest
- Optional. If present, then retrieve the next batch of results from the
preceding call to this method.
pageTokenmust be the value ofnextPageTokenfrom the previous response. The values of other method parameters should be identical to those in the previous call. - ListExclusionsRequest::getPageSize() — Method in class ListExclusionsRequest
- Optional. The maximum number of results to return from this request.
- ListExclusionsResponse::getExclusions() — Method in class ListExclusionsResponse
- A list of exclusions.
- ListExclusionsResponse::getNextPageToken() — Method in class ListExclusionsResponse
- If there might be more results than appear in this response, then
nextPageTokenis included. To get the next set of results, call the same method again using the value ofnextPageTokenaspageToken. - ListLogEntriesRequest::getProjectIds() — Method in class ListLogEntriesRequest
- Deprecated. Use
resource_namesinstead. One or more project identifiers or project numbers from which to retrieve log entries. Example:"my-project-1A". If present, these project identifiers are converted to resource name format and added to the list of resources inresource_names. - ListLogEntriesRequest::getResourceNames() — Method in class ListLogEntriesRequest
- Required. Names of one or more parent resources from which to
retrieve log entries:
"projects/[PROJECT_ID]"
"organizations/[ORGANIZATION_ID]"
"billingAccounts/[BILLING_ACCOUNT_ID]"
"folders/[FOLDER_ID]"
Projects listed in the
project_idsfield are added to this list. - ListLogEntriesRequest::getFilter() — Method in class ListLogEntriesRequest
- Optional. A filter that chooses which log entries to return. See Advanced
Logs Filters. Only log entries that
match the filter are returned. An empty filter matches all log entries in
the resources listed in
resource_names. Referencing a parent resource that is not listed inresource_nameswill cause the filter to return no results. - ListLogEntriesRequest::getOrderBy() — Method in class ListLogEntriesRequest
- Optional. How the results should be sorted. Presently, the only permitted
values are
"timestamp asc"(default) and"timestamp desc". The first option returns entries in order of increasing values ofLogEntry.timestamp(oldest first), and the second option returns entries in order of decreasing timestamps (newest first). Entries with equal timestamps are returned in order of theirinsert_idvalues. - ListLogEntriesRequest::getPageSize() — Method in class ListLogEntriesRequest
- Optional. The maximum number of results to return from this request.
- ListLogEntriesRequest::getPageToken() — Method in class ListLogEntriesRequest
- Optional. If present, then retrieve the next batch of results from the
preceding call to this method.
page_tokenmust be the value ofnext_page_tokenfrom the previous response. The values of other method parameters should be identical to those in the previous call. - ListLogEntriesResponse::getEntries() — Method in class ListLogEntriesResponse
- A list of log entries. If
entriesis empty,nextPageTokenmay still be returned, indicating that more entries may exist. SeenextPageTokenfor more information. - ListLogEntriesResponse::getNextPageToken() — Method in class ListLogEntriesResponse
- If there might be more results than those appearing in this response, then
nextPageTokenis included. To get the next set of results, call this method again using the value ofnextPageTokenaspageToken. - ListLogMetricsRequest::getParent() — Method in class ListLogMetricsRequest
- Required. The name of the project containing the metrics: "projects/[PROJECT_ID]"
- ListLogMetricsRequest::getPageToken() — Method in class ListLogMetricsRequest
- Optional. If present, then retrieve the next batch of results from the
preceding call to this method.
pageTokenmust be the value ofnextPageTokenfrom the previous response. The values of other method parameters should be identical to those in the previous call. - ListLogMetricsRequest::getPageSize() — Method in class ListLogMetricsRequest
- Optional. The maximum number of results to return from this request.
- ListLogMetricsResponse::getMetrics() — Method in class ListLogMetricsResponse
- A list of logs-based metrics.
- ListLogMetricsResponse::getNextPageToken() — Method in class ListLogMetricsResponse
- If there might be more results than appear in this response, then
nextPageTokenis included. To get the next set of results, call this method again using the value ofnextPageTokenaspageToken. - ListLogsRequest::getParent() — Method in class ListLogsRequest
- Required. The resource name that owns the logs: "projects/[PROJECT_ID]" "organizations/[ORGANIZATION_ID]" "billingAccounts/[BILLING_ACCOUNT_ID]" "folders/[FOLDER_ID]"
- ListLogsRequest::getPageSize() — Method in class ListLogsRequest
- Optional. The maximum number of results to return from this request.
- ListLogsRequest::getPageToken() — Method in class ListLogsRequest
- Optional. If present, then retrieve the next batch of results from the
preceding call to this method.
pageTokenmust be the value ofnextPageTokenfrom the previous response. The values of other method parameters should be identical to those in the previous call. - ListLogsResponse::getLogNames() — Method in class ListLogsResponse
- A list of log names. For example,
"projects/my-project/syslog"or"organizations/123/cloudresourcemanager.googleapis.com%2Factivity". - ListLogsResponse::getNextPageToken() — Method in class ListLogsResponse
- If there might be more results than those appearing in this response, then
nextPageTokenis included. To get the next set of results, call this method again using the value ofnextPageTokenaspageToken. - ListMonitoredResourceDescriptorsRequest::getPageSize() — Method in class ListMonitoredResourceDescriptorsRequest
- Optional. The maximum number of results to return from this request.
- ListMonitoredResourceDescriptorsRequest::getPageToken() — Method in class ListMonitoredResourceDescriptorsRequest
- Optional. If present, then retrieve the next batch of results from the
preceding call to this method.
pageTokenmust be the value ofnextPageTokenfrom the previous response. The values of other method parameters should be identical to those in the previous call. - ListMonitoredResourceDescriptorsResponse::getResourceDescriptors() — Method in class ListMonitoredResourceDescriptorsResponse
- A list of resource descriptors.
- ListMonitoredResourceDescriptorsResponse::getNextPageToken() — Method in class ListMonitoredResourceDescriptorsResponse
- If there might be more results than those appearing in this response, then
nextPageTokenis included. To get the next set of results, call this method again using the value ofnextPageTokenaspageToken. - ListSinksRequest::getParent() — Method in class ListSinksRequest
- Required. The parent resource whose sinks are to be listed: "projects/[PROJECT_ID]" "organizations/[ORGANIZATION_ID]" "billingAccounts/[BILLING_ACCOUNT_ID]" "folders/[FOLDER_ID]"
- ListSinksRequest::getPageToken() — Method in class ListSinksRequest
- Optional. If present, then retrieve the next batch of results from the
preceding call to this method.
pageTokenmust be the value ofnextPageTokenfrom the previous response. The values of other method parameters should be identical to those in the previous call. - ListSinksRequest::getPageSize() — Method in class ListSinksRequest
- Optional. The maximum number of results to return from this request.
- ListSinksResponse::getSinks() — Method in class ListSinksResponse
- A list of sinks.
- ListSinksResponse::getNextPageToken() — Method in class ListSinksResponse
- If there might be more results than appear in this response, then
nextPageTokenis included. To get the next set of results, call the same method again using the value ofnextPageTokenaspageToken. - LogEntry::getLogName() — Method in class LogEntry
- Required. The resource name of the log to which this log entry belongs:
"projects/[PROJECT_ID]/logs/[LOG_ID]"
"organizations/[ORGANIZATION_ID]/logs/[LOG_ID]"
"billingAccounts/[BILLING_ACCOUNT_ID]/logs/[LOG_ID]"
"folders/[FOLDER_ID]/logs/[LOG_ID]"
A project number may optionally be used in place of PROJECT_ID. The
project number is translated to its corresponding PROJECT_ID internally
and the
log_namefield will contain PROJECT_ID in queries and exports. - LogEntry::getResource() — Method in class LogEntry
- Required. The monitored resource associated with this log entry.
- LogEntry::getProtoPayload() — Method in class LogEntry
- The log entry payload, represented as a protocol buffer. Some Google Cloud Platform services use this field for their log entry payloads.
- LogEntry::getTextPayload() — Method in class LogEntry
- The log entry payload, represented as a Unicode string (UTF-8).
- LogEntry::getJsonPayload() — Method in class LogEntry
- The log entry payload, represented as a structure that is expressed as a JSON object.
- LogEntry::getTimestamp() — Method in class LogEntry
- Optional. The time the event described by the log entry occurred.
- LogEntry::getReceiveTimestamp() — Method in class LogEntry
- Output only. The time the log entry was received by Stackdriver Logging.
- LogEntry::getSeverity() — Method in class LogEntry
- Optional. The severity of the log entry. The default value is
LogSeverity.DEFAULT. - LogEntry::getInsertId() — Method in class LogEntry
- Optional. A unique identifier for the log entry. If you provide a value,
then Stackdriver Logging considers other log entries in the same project,
with the same
timestamp, and with the sameinsert_idto be duplicates which can be removed. If omitted in new log entries, then Stackdriver Logging assigns its own unique identifier. Theinsert_idis also used to order log entries that have the sametimestampvalue. - LogEntry::getHttpRequest() — Method in class LogEntry
- Optional. Information about the HTTP request associated with this log entry, if applicable.
- LogEntry::getLabels() — Method in class LogEntry
- Optional. A set of user-defined (key, value) data that provides additional information about the log entry.
- LogEntry::getOperation() — Method in class LogEntry
- Optional. Information about an operation associated with the log entry, if applicable.
- LogEntry::getTrace() — Method in class LogEntry
- Optional. Resource name of the trace associated with the log entry, if any.
- LogEntry::getSpanId() — Method in class LogEntry
- Optional. Id of the span within the trace associated with the log entry.
- LogEntry::getSourceLocation() — Method in class LogEntry
- Optional. Source code location information associated with the log entry, if any.
- LogEntry::getPayload() — Method in class LogEntry
- LogEntryOperation::getId() — Method in class LogEntryOperation
- Optional. An arbitrary operation identifier. Log entries with the same identifier are assumed to be part of the same operation.
- LogEntryOperation::getProducer() — Method in class LogEntryOperation
- Optional. An arbitrary producer identifier. The combination of
idandproducermust be globally unique. Examples forproducer:"MyDivision.MyBigCompany.com","github.com/MyProject/MyApplication". - LogEntryOperation::getFirst() — Method in class LogEntryOperation
- Optional. Set this to True if this is the first log entry in the operation.
- LogEntryOperation::getLast() — Method in class LogEntryOperation
- Optional. Set this to True if this is the last log entry in the operation.
- LogEntrySourceLocation::getFile() — Method in class LogEntrySourceLocation
- Optional. Source file name. Depending on the runtime environment, this might be a simple name or a fully-qualified name.
- LogEntrySourceLocation::getLine() — Method in class LogEntrySourceLocation
- Optional. Line within the source file. 1-based; 0 indicates no line number available.
- LogEntrySourceLocation::getFunction() — Method in class LogEntrySourceLocation
- Optional. Human-readable name of the function or method being invoked, with
optional context such as the class or package name. This information may be
used in contexts such as the logs viewer, where a file and line number are
less meaningful. The format can vary by language. For example:
qual.if.ied.Class.method(Java),dir/package.func(Go),function(Python). - LogExclusion::getName() — Method in class LogExclusion
- Required. A client-assigned identifier, such as
"load-balancer-exclusion". Identifiers are limited to 100 characters and can include only letters, digits, underscores, hyphens, and periods. - LogExclusion::getDescription() — Method in class LogExclusion
- Optional. A description of this exclusion.
- LogExclusion::getFilter() — Method in class LogExclusion
- Required.
- LogExclusion::getDisabled() — Method in class LogExclusion
- Optional. If set to True, then this exclusion is disabled and it does not exclude any log entries. You can use exclusions.patch to change the value of this field.
- LogMetric::getName() — Method in class LogMetric
- Required. The client-assigned metric identifier.
- LogMetric::getDescription() — Method in class LogMetric
- Optional. A description of this metric, which is used in documentation.
- LogMetric::getFilter() — Method in class LogMetric
- Required. An advanced logs filter which is used to match log entries.
- LogMetric::getMetricDescriptor() — Method in class LogMetric
- Optional. The metric descriptor associated with the logs-based metric.
- LogMetric::getValueExtractor() — Method in class LogMetric
- Optional. A
value_extractoris required when using a distribution logs-based metric to extract the values to record from a log entry. - LogMetric::getLabelExtractors() — Method in class LogMetric
- Optional. A map from a label key string to an extractor expression which is used to extract data from a log entry field and assign as the label value.
- LogMetric::getBucketOptions() — Method in class LogMetric
- Optional. The
bucket_optionsare required when the logs-based metric is using a DISTRIBUTION value type and it describes the bucket boundaries used to create a histogram of the extracted values. - LogMetric::getVersion() — Method in class LogMetric
- Deprecated. The API version that created or updated this metric.
- LogSink::getName() — Method in class LogSink
- Required. The client-assigned sink identifier, unique within the
project. Example:
"my-syslog-errors-to-pubsub". Sink identifiers are limited to 100 characters and can include only the following characters: upper and lower-case alphanumeric characters, underscores, hyphens, and periods. - LogSink::getDestination() — Method in class LogSink
- Required. The export destination:
"storage.googleapis.com/[GCS_BUCKET]"
"bigquery.googleapis.com/projects/[PROJECT_ID]/datasets/[DATASET]"
"pubsub.googleapis.com/projects/[PROJECT_ID]/topics/[TOPIC_ID]"
The sink's
writer_identity, set when the sink is created, must have permission to write to the destination or else the log entries are not exported. For more information, see Exporting Logs With Sinks. - LogSink::getFilter() — Method in class LogSink
- Optional.
- LogSink::getOutputVersionFormat() — Method in class LogSink
- Deprecated. The log entry format to use for this sink's exported log entries. The v2 format is used by default and cannot be changed.
- LogSink::getWriterIdentity() — Method in class LogSink
- Output only. An IAM identity—a service account or group—under
which Stackdriver Logging writes the exported log entries to the sink's
destination. This field is set by
sinks.create
and
sinks.update,
based on the setting of
unique_writer_identityin those methods. - LogSink::getIncludeChildren() — Method in class LogSink
- Optional. This field applies only to sinks owned by organizations and
folders. If the field is false, the default, only the logs owned by the
sink's parent resource are available for export. If the field is true, then
logs from all the projects, folders, and billing accounts contained in the
sink's parent resource are also available for export. Whether a particular
log entry from the children is exported depends on the sink's filter
expression. For example, if this field is true, then the filter
resource.type=gce_instancewould export all Compute Engine VM instance log entries from all projects in the sink's parent. To only export entries from certain child projects, filter on the project part of the log name: logName:("projects/test-project1/" OR "projects/test-project2/") AND resource.type=gce_instance - LogSink::getStartTime() — Method in class LogSink
- Deprecated. This field is ignored when creating or updating sinks.
- LogSink::getEndTime() — Method in class LogSink
- Deprecated. This field is ignored when creating or updating sinks.
- MetricsServiceV2GrpcClient::GetLogMetric() — Method in class MetricsServiceV2GrpcClient
- Gets a logs-based metric.
- UpdateExclusionRequest::getName() — Method in class UpdateExclusionRequest
- Required. The resource name of the exclusion to update:
"projects/[PROJECT_ID]/exclusions/[EXCLUSION_ID]"
"organizations/[ORGANIZATION_ID]/exclusions/[EXCLUSION_ID]"
"billingAccounts/[BILLING_ACCOUNT_ID]/exclusions/[EXCLUSION_ID]"
"folders/[FOLDER_ID]/exclusions/[EXCLUSION_ID]"
Example:
"projects/my-project-id/exclusions/my-exclusion-id". - UpdateExclusionRequest::getExclusion() — Method in class UpdateExclusionRequest
- Required. New values for the existing exclusion. Only the fields specified
in
update_maskare relevant. - UpdateExclusionRequest::getUpdateMask() — Method in class UpdateExclusionRequest
- Required. A nonempty list of fields to change in the existing exclusion.
- UpdateLogMetricRequest::getMetricName() — Method in class UpdateLogMetricRequest
- The resource name of the metric to update:
"projects/[PROJECT_ID]/metrics/[METRIC_ID]"
The updated metric must be provided in the request and it's
namefield must be the same as[METRIC_ID]If the metric does not exist in[PROJECT_ID], then a new metric is created. - UpdateLogMetricRequest::getMetric() — Method in class UpdateLogMetricRequest
- The updated metric.
- UpdateSinkRequest::getSinkName() — Method in class UpdateSinkRequest
- Required. The full resource name of the sink to update, including the
parent resource and the sink identifier:
"projects/[PROJECT_ID]/sinks/[SINK_ID]"
"organizations/[ORGANIZATION_ID]/sinks/[SINK_ID]"
"billingAccounts/[BILLING_ACCOUNT_ID]/sinks/[SINK_ID]"
"folders/[FOLDER_ID]/sinks/[SINK_ID]"
Example:
"projects/my-project-id/sinks/my-sink-id". - UpdateSinkRequest::getSink() — Method in class UpdateSinkRequest
- Required. The updated sink, whose name is the same identifier that appears
as part of
sink_name. - UpdateSinkRequest::getUniqueWriterIdentity() — Method in class UpdateSinkRequest
- Optional. See
sinks.create
for a description of this field. When updating a sink, the effect of this
field on the value of
writer_identityin the updated sink depends on both the old and new values of this field: + If the old and new values of this field are both false or both true, then there is no change to the sink'swriter_identity. - UpdateSinkRequest::getUpdateMask() — Method in class UpdateSinkRequest
- Optional. Field mask that specifies the fields in
sinkthat need an update. A sink field will be overwritten if, and only if, it is in the update mask.nameand output only fields cannot be updated. - WriteLogEntriesPartialErrors::getLogEntryErrors() — Method in class WriteLogEntriesPartialErrors
- When
WriteLogEntriesRequest.partial_successis true, records the error status for entries that were not written due to a permanent error, keyed by the entry's zero-based index inWriteLogEntriesRequest.entries. - WriteLogEntriesRequest::getLogName() — Method in class WriteLogEntriesRequest
- Optional. A default log resource name that is assigned to all log entries
in
entriesthat do not specify a value forlog_name: "projects/[PROJECT_ID]/logs/[LOG_ID]" "organizations/[ORGANIZATION_ID]/logs/[LOG_ID]" "billingAccounts/[BILLING_ACCOUNT_ID]/logs/[LOG_ID]" "folders/[FOLDER_ID]/logs/[LOG_ID]"[LOG_ID]must be URL-encoded. For example,"projects/my-project-id/logs/syslog"or"organizations/1234567890/logs/cloudresourcemanager.googleapis.com%2Factivity". - WriteLogEntriesRequest::getResource() — Method in class WriteLogEntriesRequest
- Optional. A default monitored resource object that is assigned to all log
entries in
entriesthat do not specify a value forresource. Example: { "type": "gce_instance", "labels": { "zone": "us-central1-a", "instance_id": "00000000000000000000" }} See [LogEntry][google.logging.v2.LogEntry]. - WriteLogEntriesRequest::getLabels() — Method in class WriteLogEntriesRequest
- Optional. Default labels that are added to the
labelsfield of all log entries inentries. If a log entry already has a label with the same key as a label in this parameter, then the log entry's label is not changed. - WriteLogEntriesRequest::getEntries() — Method in class WriteLogEntriesRequest
- Required. The log entries to send to Stackdriver Logging. The order of log
entries in this list does not matter. Values supplied in this method's
log_name,resource, andlabelsfields are copied into those log entries in this list that do not include values for their corresponding fields. For more information, see the [LogEntry][google.logging.v2.LogEntry] type. - WriteLogEntriesRequest::getPartialSuccess() — Method in class WriteLogEntriesRequest
- Optional. Whether valid entries should be written even if some other
entries fail due to INVALID_ARGUMENT or PERMISSION_DENIED errors. If any
entry is not written, then the response status is the error associated
with one of the failed entries and the response includes error details
keyed by the entries' zero-based index in the
entries.writemethod. - Aggregation::getAlignmentPeriod() — Method in class Aggregation
- The alignment period for per-[time series][google.monitoring.v3.TimeSeries]
alignment. If present,
alignmentPeriodmust be at least 60 seconds. After per-time series alignment, each time series will contain data points only on the period boundaries. IfperSeriesAligneris not specified or equalsALIGN_NONE, then this field is ignored. IfperSeriesAligneris specified and does not equalALIGN_NONE, then this field must be defined; otherwise an error is returned. - Aggregation::getPerSeriesAligner() — Method in class Aggregation
- The approach to be used to align individual time series. Not all alignment functions may be applied to all time series, depending on the metric type and value type of the original time series. Alignment may change the metric type or the value type of the time series.
- Aggregation::getCrossSeriesReducer() — Method in class Aggregation
- The approach to be used to combine time series. Not all reducer functions may be applied to all time series, depending on the metric type and the value type of the original time series. Reduction may change the metric type of value type of the time series.
- Aggregation::getGroupByFields() — Method in class Aggregation
- The set of fields to preserve when
crossSeriesReduceris specified. ThegroupByFieldsdetermine how the time series are partitioned into subsets prior to applying the aggregation function. Each subset contains time series that have the same value for each of the grouping fields. Each individual time series is a member of exactly one subset. ThecrossSeriesReduceris applied to each subset of time series. - AlertPolicy::getName() — Method in class AlertPolicy
- Required if the policy exists. The resource name for this policy. The
syntax is:
projects/[PROJECT_ID]/alertPolicies/[ALERT_POLICY_ID]
[ALERT_POLICY_ID]is assigned by Stackdriver Monitoring when the policy is created. When calling the [alertPolicies.create][google.monitoring.v3.AlertPolicyService.CreateAlertPolicy] method, do not include thenamefield in the alerting policy passed as part of the request. - AlertPolicy::getDisplayName() — Method in class AlertPolicy
- A short name or phrase used to identify the policy in dashboards, notifications, and incidents. To avoid confusion, don't use the same display name for multiple policies in the same project. The name is limited to 512 Unicode characters.
- AlertPolicy::getDocumentation() — Method in class AlertPolicy
- Documentation that is included with notifications and incidents related to this policy. Best practice is for the documentation to include information to help responders understand, mitigate, escalate, and correct the underlying problems detected by the alerting policy. Notification channels that have limited capacity might not show this documentation.
- AlertPolicy::getUserLabels() — Method in class AlertPolicy
- User-supplied key/value data to be used for organizing and
identifying the
AlertPolicyobjects. - AlertPolicy::getConditions() — Method in class AlertPolicy
- A list of conditions for the policy. The conditions are combined by AND or
OR according to the
combinerfield. If the combined conditions evaluate to true, then an incident is created. A policy can have from one to six conditions. - AlertPolicy::getCombiner() — Method in class AlertPolicy
- How to combine the results of multiple conditions to determine if an incident should be opened.
- AlertPolicy::getEnabled() — Method in class AlertPolicy
- Whether or not the policy is enabled. On write, the default interpretation if unset is that the policy is enabled. On read, clients should not make any assumption about the state if it has not been populated. The field should always be populated on List and Get operations, unless a field projection has been specified that strips it out.
- AlertPolicy::getNotificationChannels() — Method in class AlertPolicy
- Identifies the notification channels to which notifications should be sent
when incidents are opened or closed or when new violations occur on
an already opened incident. Each element of this array corresponds to
the
namefield in each of the [NotificationChannel][google.monitoring.v3.NotificationChannel] objects that are returned from the [ListNotificationChannels] [google.monitoring.v3.NotificationChannelService.ListNotificationChannels] method. The syntax of the entries in this field is: projects/[PROJECT_ID]/notificationChannels/[CHANNEL_ID] - AlertPolicy::getCreationRecord() — Method in class AlertPolicy
- A read-only record of the creation of the alerting policy. If provided in a call to create or update, this field will be ignored.
- AlertPolicy::getMutationRecord() — Method in class AlertPolicy
- A read-only record of the most recent change to the alerting policy. If provided in a call to create or update, this field will be ignored.
- AlertPolicyServiceGrpcClient::GetAlertPolicy() — Method in class AlertPolicyServiceGrpcClient
- Gets a single alerting policy.
- AlertPolicy_Condition::getName() — Method in class AlertPolicy_Condition
- Required if the condition exists. The unique resource name for this
condition. Its syntax is:
projects/[PROJECT_ID]/alertPolicies/[POLICY_ID]/conditions/[CONDITION_ID]
[CONDITION_ID]is assigned by Stackdriver Monitoring when the condition is created as part of a new or updated alerting policy. - AlertPolicy_Condition::getDisplayName() — Method in class AlertPolicy_Condition
- A short name or phrase used to identify the condition in dashboards, notifications, and incidents. To avoid confusion, don't use the same display name for multiple conditions in the same policy.
- AlertPolicy_Condition::getConditionThreshold() — Method in class AlertPolicy_Condition
- A condition that compares a time series against a threshold.
- AlertPolicy_Condition::getConditionAbsent() — Method in class AlertPolicy_Condition
- A condition that checks that a time series continues to receive new data points.
- AlertPolicy_Condition::getCondition() — Method in class AlertPolicy_Condition
- AlertPolicy_Condition_MetricAbsence::getFilter() — Method in class AlertPolicy_Condition_MetricAbsence
- A filter that identifies which time series should be compared with the threshold.
- AlertPolicy_Condition_MetricAbsence::getAggregations() — Method in class AlertPolicy_Condition_MetricAbsence
- Specifies the alignment of data points in individual time series as well as how to combine the retrieved time series together (such as when aggregating multiple streams on each resource to a single stream for each resource or when aggregating streams across all members of a group of resrouces). Multiple aggregations are applied in the order specified.
- AlertPolicy_Condition_MetricAbsence::getDuration() — Method in class AlertPolicy_Condition_MetricAbsence
- The amount of time that a time series must fail to report new
data to be considered failing. Currently, only values that
are a multiple of a minute--e.g. 60, 120, or 300
seconds--are supported. If an invalid value is given, an
error will be returned. The
Duration.nanosfield is ignored. - AlertPolicy_Condition_MetricAbsence::getTrigger() — Method in class AlertPolicy_Condition_MetricAbsence
- The number/percent of time series for which the comparison must hold
in order for the condition to trigger. If unspecified, then the
condition will trigger if the comparison is true for any of the
time series that have been identified by
filterandaggregations. - AlertPolicy_Condition_MetricThreshold::getFilter() — Method in class AlertPolicy_Condition_MetricThreshold
- A filter that identifies which time series should be compared with the threshold.
- AlertPolicy_Condition_MetricThreshold::getAggregations() — Method in class AlertPolicy_Condition_MetricThreshold
- Specifies the alignment of data points in individual time series as well as how to combine the retrieved time series together (such as when aggregating multiple streams on each resource to a single stream for each resource or when aggregating streams across all members of a group of resrouces). Multiple aggregations are applied in the order specified.
- AlertPolicy_Condition_MetricThreshold::getDenominatorFilter() — Method in class AlertPolicy_Condition_MetricThreshold
- A filter that identifies a time
series that should be used as the denominator of a ratio that will be
compared with the threshold. If a
denominator_filteris specified, the time series specified by thefilterfield will be used as the numerator. - AlertPolicy_Condition_MetricThreshold::getDenominatorAggregations() — Method in class AlertPolicy_Condition_MetricThreshold
- Specifies the alignment of data points in individual time series
selected by
denominatorFilteras well as how to combine the retrieved time series together (such as when aggregating multiple streams on each resource to a single stream for each resource or when aggregating streams across all members of a group of resources). - AlertPolicy_Condition_MetricThreshold::getComparison() — Method in class AlertPolicy_Condition_MetricThreshold
- The comparison to apply between the time series (indicated by
filterandaggregation) and the threshold (indicated bythreshold_value). - AlertPolicy_Condition_MetricThreshold::getThresholdValue() — Method in class AlertPolicy_Condition_MetricThreshold
- A value against which to compare the time series.
- AlertPolicy_Condition_MetricThreshold::getDuration() — Method in class AlertPolicy_Condition_MetricThreshold
- The amount of time that a time series must violate the
threshold to be considered failing. Currently, only values
that are a multiple of a minute--e.g. 60, 120, or 300
seconds--are supported. If an invalid value is given, an
error will be returned. The
Duration.nanosfield is ignored. When choosing a duration, it is useful to keep in mind the frequency of the underlying time series data (which may also be affected by any alignments specified in theaggregationfield); a good duration is long enough so that a single outlier does not generate spurious alerts, but short enough that unhealthy states are detected and alerted on quickly. - AlertPolicy_Condition_MetricThreshold::getTrigger() — Method in class AlertPolicy_Condition_MetricThreshold
- The number/percent of time series for which the comparison must hold
in order for the condition to trigger. If unspecified, then the
condition will trigger if the comparison is true for any of the
time series that have been identified by
filterandaggregations, or by the ratio, ifdenominator_filteranddenominator_aggregationsare specified. - AlertPolicy_Condition_Trigger::getCount() — Method in class AlertPolicy_Condition_Trigger
- The absolute number of time series that must fail the predicate for the condition to be triggered.
- AlertPolicy_Condition_Trigger::getPercent() — Method in class AlertPolicy_Condition_Trigger
- The percentage of time series that must fail the predicate for the condition to be triggered.
- AlertPolicy_Condition_Trigger::getType() — Method in class AlertPolicy_Condition_Trigger
- AlertPolicy_Documentation::getContent() — Method in class AlertPolicy_Documentation
- The text of the documentation, interpreted according to
mime_type. - AlertPolicy_Documentation::getMimeType() — Method in class AlertPolicy_Documentation
- The format of the
contentfield. Presently, only the value"text/markdown"is supported. See Markdown for more information. - CreateAlertPolicyRequest::getName() — Method in class CreateAlertPolicyRequest
- The project in which to create the alerting policy. The format is
projects/[PROJECT_ID]. - CreateAlertPolicyRequest::getAlertPolicy() — Method in class CreateAlertPolicyRequest
- The requested alerting policy. You should omit the
namefield in this policy. The name will be returned in the new policy, including a new [ALERT_POLICY_ID] value. - CreateGroupRequest::getName() — Method in class CreateGroupRequest
- The project in which to create the group. The format is
"projects/{project_id_or_number}". - CreateGroupRequest::getGroup() — Method in class CreateGroupRequest
- A group definition. It is an error to define the
namefield because the system assigns the name. - CreateGroupRequest::getValidateOnly() — Method in class CreateGroupRequest
- If true, validate this request but do not create the group.
- CreateMetricDescriptorRequest::getName() — Method in class CreateMetricDescriptorRequest
- The project on which to execute the request. The format is
"projects/{project_id_or_number}". - CreateMetricDescriptorRequest::getMetricDescriptor() — Method in class CreateMetricDescriptorRequest
- The new custom metric descriptor.
- CreateNotificationChannelRequest::getName() — Method in class CreateNotificationChannelRequest
- The project on which to execute the request. The format is:
projects/[PROJECT_ID]
Note that this names the container into which the channel will be
written. This does not name the newly created channel. The resulting
channel's name will have a normalized version of this field as a prefix,
but will add
/notificationChannels/[CHANNEL_ID]to identify the channel. - CreateNotificationChannelRequest::getNotificationChannel() — Method in class CreateNotificationChannelRequest
- The definition of the
NotificationChannelto create. - CreateTimeSeriesError::getTimeSeries() — Method in class CreateTimeSeriesError
- The time series, including the
Metric,MonitoredResource, andPoints (including timestamp and value) that resulted in the error. This field provides all of the context that would be needed to retry the operation. - CreateTimeSeriesError::getStatus() — Method in class CreateTimeSeriesError
- The status of the requested write operation.
- CreateTimeSeriesRequest::getName() — Method in class CreateTimeSeriesRequest
- The project on which to execute the request. The format is
"projects/{project_id_or_number}". - CreateTimeSeriesRequest::getTimeSeries() — Method in class CreateTimeSeriesRequest
- The new data to be added to a list of time series.
- CreateUptimeCheckConfigRequest::getParent() — Method in class CreateUptimeCheckConfigRequest
- The project in which to create the uptime check. The format is:
projects/[PROJECT_ID]. - CreateUptimeCheckConfigRequest::getUptimeCheckConfig() — Method in class CreateUptimeCheckConfigRequest
- The new uptime check configuration.
- DeleteAlertPolicyRequest::getName() — Method in class DeleteAlertPolicyRequest
- The alerting policy to delete. The format is: projects/[PROJECT_ID]/alertPolicies/[ALERT_POLICY_ID] For more information, see [AlertPolicy][google.monitoring.v3.AlertPolicy].
- DeleteGroupRequest::getName() — Method in class DeleteGroupRequest
- The group to delete. The format is
"projects/{project_id_or_number}/groups/{group_id}". - DeleteMetricDescriptorRequest::getName() — Method in class DeleteMetricDescriptorRequest
- The metric descriptor on which to execute the request. The format is
"projects/{project_id_or_number}/metricDescriptors/{metric_id}". - DeleteNotificationChannelRequest::getName() — Method in class DeleteNotificationChannelRequest
- The channel for which to execute the request. The format is
projects/[PROJECT_ID]/notificationChannels/[CHANNEL_ID]. - DeleteNotificationChannelRequest::getForce() — Method in class DeleteNotificationChannelRequest
- If true, the notification channel will be deleted regardless of its use in alert policies (the policies will be updated to remove the channel). If false, channels that are still referenced by an existing alerting policy will fail to be deleted in a delete operation.
- DeleteUptimeCheckConfigRequest::getName() — Method in class DeleteUptimeCheckConfigRequest
- The uptime check configuration to delete. The format is
projects/[PROJECT_ID]/uptimeCheckConfigs/[UPTIME_CHECK_ID]. - GetAlertPolicyRequest — Class in namespace Google\Cloud\Monitoring\V3
- The protocol for the
GetAlertPolicyrequest. - GetAlertPolicyRequest::getName() — Method in class GetAlertPolicyRequest
- The alerting policy to retrieve. The format is projects/[PROJECT_ID]/alertPolicies/[ALERT_POLICY_ID]
- GetGroupRequest — Class in namespace Google\Cloud\Monitoring\V3
- The
GetGrouprequest. - GetGroupRequest::getName() — Method in class GetGroupRequest
- The group to retrieve. The format is
"projects/{project_id_or_number}/groups/{group_id}". - GetMetricDescriptorRequest — Class in namespace Google\Cloud\Monitoring\V3
- The
GetMetricDescriptorrequest. - GetMetricDescriptorRequest::getName() — Method in class GetMetricDescriptorRequest
- The metric descriptor on which to execute the request. The format is
"projects/{project_id_or_number}/metricDescriptors/{metric_id}". - GetMonitoredResourceDescriptorRequest — Class in namespace Google\Cloud\Monitoring\V3
- The
GetMonitoredResourceDescriptorrequest. - GetMonitoredResourceDescriptorRequest::getName() — Method in class GetMonitoredResourceDescriptorRequest
- The monitored resource descriptor to get. The format is
"projects/{project_id_or_number}/monitoredResourceDescriptors/{resource_type}". - GetNotificationChannelDescriptorRequest — Class in namespace Google\Cloud\Monitoring\V3
- The
GetNotificationChannelDescriptorresponse. - GetNotificationChannelDescriptorRequest::getName() — Method in class GetNotificationChannelDescriptorRequest
- The channel type for which to execute the request. The format is
projects/[PROJECT_ID]/notificationChannelDescriptors/{channel_type}. - GetNotificationChannelRequest — Class in namespace Google\Cloud\Monitoring\V3
- The
GetNotificationChannelrequest. - GetNotificationChannelRequest::getName() — Method in class GetNotificationChannelRequest
- The channel for which to execute the request. The format is
projects/[PROJECT_ID]/notificationChannels/[CHANNEL_ID]. - GetNotificationChannelVerificationCodeRequest — Class in namespace Google\Cloud\Monitoring\V3
- The
GetNotificationChannelVerificationCoderequest. - GetNotificationChannelVerificationCodeRequest::getName() — Method in class GetNotificationChannelVerificationCodeRequest
- The notification channel for which a verification code is to be generated and retrieved. This must name a channel that is already verified; if the specified channel is not verified, the request will fail.
- GetNotificationChannelVerificationCodeRequest::getExpireTime() — Method in class GetNotificationChannelVerificationCodeRequest
- The desired expiration time. If specified, the API will guarantee that the returned code will not be valid after the specified timestamp; however, the API cannot guarantee that the returned code will be valid for at least as long as the requested time (the API puts an upper bound on the amount of time for which a code may be valid). If omitted, a default expiration will be used, which may be less than the max permissible expiration (so specifying an expiration may extend the code's lifetime over omitting an expiration, even though the API does impose an upper limit on the maximum expiration that is permitted).
- GetNotificationChannelVerificationCodeResponse — Class in namespace Google\Cloud\Monitoring\V3
- The
GetNotificationChannelVerificationCoderequest. - GetNotificationChannelVerificationCodeResponse::getCode() — Method in class GetNotificationChannelVerificationCodeResponse
- The verification code, which may be used to verify other channels that have an equivalent identity (i.e. other channels of the same type with the same fingerprint such as other email channels with the same email address or other sms channels with the same number).
- GetNotificationChannelVerificationCodeResponse::getExpireTime() — Method in class GetNotificationChannelVerificationCodeResponse
- The expiration time associated with the code that was returned. If an expiration was provided in the request, this is the minimum of the requested expiration in the request and the max permitted expiration.
- GetUptimeCheckConfigRequest — Class in namespace Google\Cloud\Monitoring\V3
- The protocol for the
GetUptimeCheckConfigrequest. - GetUptimeCheckConfigRequest::getName() — Method in class GetUptimeCheckConfigRequest
- The uptime check configuration to retrieve. The format is
projects/[PROJECT_ID]/uptimeCheckConfigs/[UPTIME_CHECK_ID]. - Group — Class in namespace Google\Cloud\Monitoring\V3
- The description of a dynamic collection of monitored resources. Each group has a filter that is matched against monitored resources and their associated metadata. If a group's filter matches an available monitored resource, then that resource is a member of that group. Groups can contain any number of monitored resources, and each monitored resource can be a member of any number of groups.
- Group::getName() — Method in class Group
- Output only. The name of this group. The format is
"projects/{project_id_or_number}/groups/{group_id}". - Group::getDisplayName() — Method in class Group
- A user-assigned name for this group, used only for display purposes.
- Group::getParentName() — Method in class Group
- The name of the group's parent, if it has one.
- Group::getFilter() — Method in class Group
- The filter used to determine which monitored resources belong to this group.
- Group::getIsCluster() — Method in class Group
- If true, the members of this group are considered to be a cluster.
- GroupResourceType — Class in namespace Google\Cloud\Monitoring\V3
- The supported resource types that can be used as values of group_resource.resource_type. gae_app and uptime_url are not allowed because group checks on App Engine modules and URLs are not allowed.
- GroupServiceGrpcClient — Class in namespace Google\Cloud\Monitoring\V3
- The Group API lets you inspect and manage your groups.
- GroupServiceGrpcClient::GetGroup() — Method in class GroupServiceGrpcClient
- Gets a single group.
- ListAlertPoliciesRequest::getName() — Method in class ListAlertPoliciesRequest
- The project whose alert policies are to be listed. The format is projects/[PROJECT_ID] Note that this field names the parent container in which the alerting policies to be listed are stored. To retrieve a single alerting policy by name, use the [GetAlertPolicy][google.monitoring.v3.AlertPolicyService.GetAlertPolicy] operation, instead.
- ListAlertPoliciesRequest::getFilter() — Method in class ListAlertPoliciesRequest
- If provided, this field specifies the criteria that must be met by alert policies to be included in the response.
- ListAlertPoliciesRequest::getOrderBy() — Method in class ListAlertPoliciesRequest
- A comma-separated list of fields by which to sort the result. Supports
the same set of field references as the
filterfield. Entries can be prefixed with a minus sign to sort by the field in descending order. - ListAlertPoliciesRequest::getPageSize() — Method in class ListAlertPoliciesRequest
- The maximum number of results to return in a single response.
- ListAlertPoliciesRequest::getPageToken() — Method in class ListAlertPoliciesRequest
- If this field is not empty then it must contain the
nextPageTokenvalue returned by a previous call to this method. Using this field causes the method to return more results from the previous method call. - ListAlertPoliciesResponse::getAlertPolicies() — Method in class ListAlertPoliciesResponse
- The returned alert policies.
- ListAlertPoliciesResponse::getNextPageToken() — Method in class ListAlertPoliciesResponse
- If there might be more results than were returned, then this field is set
to a non-empty value. To see the additional results,
use that value as
pageTokenin the next call to this method. - ListGroupMembersRequest::getName() — Method in class ListGroupMembersRequest
- The group whose members are listed. The format is
"projects/{project_id_or_number}/groups/{group_id}". - ListGroupMembersRequest::getPageSize() — Method in class ListGroupMembersRequest
- A positive number that is the maximum number of results to return.
- ListGroupMembersRequest::getPageToken() — Method in class ListGroupMembersRequest
- If this field is not empty then it must contain the
nextPageTokenvalue returned by a previous call to this method. Using this field causes the method to return additional results from the previous method call. - ListGroupMembersRequest::getFilter() — Method in class ListGroupMembersRequest
- An optional list filter describing the members to be returned. The filter may reference the type, labels, and metadata of monitored resources that comprise the group.
- ListGroupMembersRequest::getInterval() — Method in class ListGroupMembersRequest
- An optional time interval for which results should be returned. Only members that were part of the group during the specified interval are included in the response. If no interval is provided then the group membership over the last minute is returned.
- ListGroupMembersResponse::getMembers() — Method in class ListGroupMembersResponse
- A set of monitored resources in the group.
- ListGroupMembersResponse::getNextPageToken() — Method in class ListGroupMembersResponse
- If there are more results than have been returned, then this field is
set to a non-empty value. To see the additional results, use that value as
pageTokenin the next call to this method. - ListGroupMembersResponse::getTotalSize() — Method in class ListGroupMembersResponse
- The total number of elements matching this request.
- ListGroupsRequest::getName() — Method in class ListGroupsRequest
- The project whose groups are to be listed. The format is
"projects/{project_id_or_number}". - ListGroupsRequest::getChildrenOfGroup() — Method in class ListGroupsRequest
- A group name:
"projects/{project_id_or_number}/groups/{group_id}". - ListGroupsRequest::getAncestorsOfGroup() — Method in class ListGroupsRequest
- A group name:
"projects/{project_id_or_number}/groups/{group_id}". - ListGroupsRequest::getDescendantsOfGroup() — Method in class ListGroupsRequest
- A group name:
"projects/{project_id_or_number}/groups/{group_id}". - ListGroupsRequest::getPageSize() — Method in class ListGroupsRequest
- A positive number that is the maximum number of results to return.
- ListGroupsRequest::getPageToken() — Method in class ListGroupsRequest
- If this field is not empty then it must contain the
nextPageTokenvalue returned by a previous call to this method. Using this field causes the method to return additional results from the previous method call. - ListGroupsRequest::getFilter() — Method in class ListGroupsRequest
- ListGroupsResponse::getGroup() — Method in class ListGroupsResponse
- The groups that match the specified filters.
- ListGroupsResponse::getNextPageToken() — Method in class ListGroupsResponse
- If there are more results than have been returned, then this field is set
to a non-empty value. To see the additional results,
use that value as
pageTokenin the next call to this method. - ListMetricDescriptorsRequest::getName() — Method in class ListMetricDescriptorsRequest
- The project on which to execute the request. The format is
"projects/{project_id_or_number}". - ListMetricDescriptorsRequest::getFilter() — Method in class ListMetricDescriptorsRequest
- If this field is empty, all custom and system-defined metric descriptors are returned.
- ListMetricDescriptorsRequest::getPageSize() — Method in class ListMetricDescriptorsRequest
- A positive number that is the maximum number of results to return.
- ListMetricDescriptorsRequest::getPageToken() — Method in class ListMetricDescriptorsRequest
- If this field is not empty then it must contain the
nextPageTokenvalue returned by a previous call to this method. Using this field causes the method to return additional results from the previous method call. - ListMetricDescriptorsResponse::getMetricDescriptors() — Method in class ListMetricDescriptorsResponse
- The metric descriptors that are available to the project
and that match the value of
filter, if present. - ListMetricDescriptorsResponse::getNextPageToken() — Method in class ListMetricDescriptorsResponse
- If there are more results than have been returned, then this field is set
to a non-empty value. To see the additional results,
use that value as
pageTokenin the next call to this method. - ListMonitoredResourceDescriptorsRequest::getName() — Method in class ListMonitoredResourceDescriptorsRequest
- The project on which to execute the request. The format is
"projects/{project_id_or_number}". - ListMonitoredResourceDescriptorsRequest::getFilter() — Method in class ListMonitoredResourceDescriptorsRequest
- An optional filter describing
the descriptors to be returned. The filter can reference
the descriptor's type and labels. For example, the
following filter returns only Google Compute Engine descriptors
that have an
idlabel: resource.type = starts_with("gce_") AND resource.label:id - ListMonitoredResourceDescriptorsRequest::getPageSize() — Method in class ListMonitoredResourceDescriptorsRequest
- A positive number that is the maximum number of results to return.
- ListMonitoredResourceDescriptorsRequest::getPageToken() — Method in class ListMonitoredResourceDescriptorsRequest
- If this field is not empty then it must contain the
nextPageTokenvalue returned by a previous call to this method. Using this field causes the method to return additional results from the previous method call. - ListMonitoredResourceDescriptorsResponse::getResourceDescriptors() — Method in class ListMonitoredResourceDescriptorsResponse
- The monitored resource descriptors that are available to this project
and that match
filter, if present. - ListMonitoredResourceDescriptorsResponse::getNextPageToken() — Method in class ListMonitoredResourceDescriptorsResponse
- If there are more results than have been returned, then this field is set
to a non-empty value. To see the additional results,
use that value as
pageTokenin the next call to this method. - ListNotificationChannelDescriptorsRequest::getName() — Method in class ListNotificationChannelDescriptorsRequest
- The REST resource name of the parent from which to retrieve the notification channel descriptors. The expected syntax is: projects/[PROJECT_ID] Note that this names the parent container in which to look for the descriptors; to retrieve a single descriptor by name, use the [GetNotificationChannelDescriptor][google.monitoring.v3.NotificationChannelService.GetNotificationChannelDescriptor] operation, instead.
- ListNotificationChannelDescriptorsRequest::getPageSize() — Method in class ListNotificationChannelDescriptorsRequest
- The maximum number of results to return in a single response. If not set to a positive number, a reasonable value will be chosen by the service.
- ListNotificationChannelDescriptorsRequest::getPageToken() — Method in class ListNotificationChannelDescriptorsRequest
- If non-empty,
page_tokenmust contain a value returned as thenext_page_tokenin a previous response to request the next set of results. - ListNotificationChannelDescriptorsResponse::getChannelDescriptors() — Method in class ListNotificationChannelDescriptorsResponse
- The monitored resource descriptors supported for the specified project, optionally filtered.
- ListNotificationChannelDescriptorsResponse::getNextPageToken() — Method in class ListNotificationChannelDescriptorsResponse
- If not empty, indicates that there may be more results that match
the request. Use the value in the
page_tokenfield in a subsequent request to fetch the next set of results. If empty, all results have been returned. - ListNotificationChannelsRequest::getName() — Method in class ListNotificationChannelsRequest
- The project on which to execute the request. The format is
projects/[PROJECT_ID]. That is, this names the container in which to look for the notification channels; it does not name a specific channel. To query a specific channel by REST resource name, use the [GetNotificationChannel][google.monitoring.v3.NotificationChannelService.GetNotificationChannel] operation. - ListNotificationChannelsRequest::getFilter() — Method in class ListNotificationChannelsRequest
- If provided, this field specifies the criteria that must be met by notification channels to be included in the response.
- ListNotificationChannelsRequest::getOrderBy() — Method in class ListNotificationChannelsRequest
- A comma-separated list of fields by which to sort the result. Supports
the same set of fields as in
filter. Entries can be prefixed with a minus sign to sort in descending rather than ascending order. - ListNotificationChannelsRequest::getPageSize() — Method in class ListNotificationChannelsRequest
- The maximum number of results to return in a single response. If not set to a positive number, a reasonable value will be chosen by the service.
- ListNotificationChannelsRequest::getPageToken() — Method in class ListNotificationChannelsRequest
- If non-empty,
page_tokenmust contain a value returned as thenext_page_tokenin a previous response to request the next set of results. - ListNotificationChannelsResponse::getNotificationChannels() — Method in class ListNotificationChannelsResponse
- The notification channels defined for the specified project.
- ListNotificationChannelsResponse::getNextPageToken() — Method in class ListNotificationChannelsResponse
- If not empty, indicates that there may be more results that match
the request. Use the value in the
page_tokenfield in a subsequent request to fetch the next set of results. If empty, all results have been returned. - ListTimeSeriesRequest::getName() — Method in class ListTimeSeriesRequest
- The project on which to execute the request. The format is "projects/{project_id_or_number}".
- ListTimeSeriesRequest::getFilter() — Method in class ListTimeSeriesRequest
- A monitoring filter that specifies which time series should be returned. The filter must specify a single metric type, and can additionally specify metric labels and other information. For example: metric.type = "compute.googleapis.com/instance/cpu/usage_time" AND metric.label.instance_name = "my-instance-name"
- ListTimeSeriesRequest::getInterval() — Method in class ListTimeSeriesRequest
- The time interval for which results should be returned. Only time series that contain data points in the specified interval are included in the response.
- ListTimeSeriesRequest::getAggregation() — Method in class ListTimeSeriesRequest
- By default, the raw time series data is returned.
- ListTimeSeriesRequest::getOrderBy() — Method in class ListTimeSeriesRequest
- Specifies the order in which the points of the time series should be returned. By default, results are not ordered. Currently, this field must be left blank.
- ListTimeSeriesRequest::getView() — Method in class ListTimeSeriesRequest
- Specifies which information is returned about the time series.
- ListTimeSeriesRequest::getPageSize() — Method in class ListTimeSeriesRequest
- A positive number that is the maximum number of results to return.
- ListTimeSeriesRequest::getPageToken() — Method in class ListTimeSeriesRequest
- If this field is not empty then it must contain the
nextPageTokenvalue returned by a previous call to this method. Using this field causes the method to return additional results from the previous method call. - ListTimeSeriesResponse::getTimeSeries() — Method in class ListTimeSeriesResponse
- One or more time series that match the filter included in the request.
- ListTimeSeriesResponse::getNextPageToken() — Method in class ListTimeSeriesResponse
- If there are more results than have been returned, then this field is set
to a non-empty value. To see the additional results,
use that value as
pageTokenin the next call to this method. - ListUptimeCheckConfigsRequest::getParent() — Method in class ListUptimeCheckConfigsRequest
- The project whose uptime check configurations are listed. The format is
projects/[PROJECT_ID]. - ListUptimeCheckConfigsRequest::getPageSize() — Method in class ListUptimeCheckConfigsRequest
- The maximum number of results to return in a single response. The server may further constrain the maximum number of results returned in a single page. If the page_size is <=0, the server will decide the number of results to be returned.
- ListUptimeCheckConfigsRequest::getPageToken() — Method in class ListUptimeCheckConfigsRequest
- If this field is not empty then it must contain the
nextPageTokenvalue returned by a previous call to this method. Using this field causes the method to return more results from the previous method call. - ListUptimeCheckConfigsResponse::getUptimeCheckConfigs() — Method in class ListUptimeCheckConfigsResponse
- The returned uptime check configurations.
- ListUptimeCheckConfigsResponse::getNextPageToken() — Method in class ListUptimeCheckConfigsResponse
- This field represents the pagination token to retrieve the next page of results. If the value is empty, it means no further results for the request. To retrieve the next page of results, the value of the next_page_token is passed to the subsequent List method call (in the request message's page_token field).
- ListUptimeCheckIpsRequest::getPageSize() — Method in class ListUptimeCheckIpsRequest
- The maximum number of results to return in a single response. The server may further constrain the maximum number of results returned in a single page. If the page_size is <=0, the server will decide the number of results to be returned.
- ListUptimeCheckIpsRequest::getPageToken() — Method in class ListUptimeCheckIpsRequest
- If this field is not empty then it must contain the
nextPageTokenvalue returned by a previous call to this method. Using this field causes the method to return more results from the previous method call. - ListUptimeCheckIpsResponse::getUptimeCheckIps() — Method in class ListUptimeCheckIpsResponse
- The returned list of IP addresses (including region and location) that the checkers run from.
- ListUptimeCheckIpsResponse::getNextPageToken() — Method in class ListUptimeCheckIpsResponse
- This field represents the pagination token to retrieve the next page of results. If the value is empty, it means no further results for the request. To retrieve the next page of results, the value of the next_page_token is passed to the subsequent List method call (in the request message's page_token field).
- MetricServiceGrpcClient::GetMonitoredResourceDescriptor() — Method in class MetricServiceGrpcClient
- Gets a single monitored resource descriptor. This method does not require a Stackdriver account.
- MetricServiceGrpcClient::GetMetricDescriptor() — Method in class MetricServiceGrpcClient
- Gets a single metric descriptor. This method does not require a Stackdriver account.
- MutationRecord::getMutateTime() — Method in class MutationRecord
- When the change occurred.
- MutationRecord::getMutatedBy() — Method in class MutationRecord
- The email address of the user making the change.
- NotificationChannel::getType() — Method in class NotificationChannel
- The type of the notification channel. This field matches the value of the [NotificationChannelDescriptor.type][google.monitoring.v3.NotificationChannelDescriptor.type] field.
- NotificationChannel::getName() — Method in class NotificationChannel
- The full REST resource name for this channel. The syntax is:
projects/[PROJECT_ID]/notificationChannels/[CHANNEL_ID]
The
[CHANNEL_ID]is automatically assigned by the server on creation. - NotificationChannel::getDisplayName() — Method in class NotificationChannel
- An optional human-readable name for this notification channel. It is recommended that you specify a non-empty and unique name in order to make it easier to identify the channels in your project, though this is not enforced. The display name is limited to 512 Unicode characters.
- NotificationChannel::getDescription() — Method in class NotificationChannel
- An optional human-readable description of this notification channel. This description may provide additional details, beyond the display name, for the channel. This may not exceeed 1024 Unicode characters.
- NotificationChannel::getLabels() — Method in class NotificationChannel
- Configuration fields that define the channel and its behavior. The
permissible and required labels are specified in the
[NotificationChannelDescriptor.labels][google.monitoring.v3.NotificationChannelDescriptor.labels] of the
NotificationChannelDescriptorcorresponding to thetypefield. - NotificationChannel::getUserLabels() — Method in class NotificationChannel
- User-supplied key/value data that does not need to conform to
the corresponding
NotificationChannelDescriptor's schema, unlike thelabelsfield. This field is intended to be used for organizing and identifying theNotificationChannelobjects. - NotificationChannel::getVerificationStatus() — Method in class NotificationChannel
- Indicates whether this channel has been verified or not. On a
[
ListNotificationChannels][google.monitoring.v3.NotificationChannelService.ListNotificationChannels] or [GetNotificationChannel][google.monitoring.v3.NotificationChannelService.GetNotificationChannel] operation, this field is expected to be populated. - NotificationChannel::getEnabled() — Method in class NotificationChannel
- Whether notifications are forwarded to the described channel. This makes it possible to disable delivery of notifications to a particular channel without removing the channel from all alerting policies that reference the channel. This is a more convenient approach when the change is temporary and you want to receive notifications from the same set of alerting policies on the channel at some point in the future.
- NotificationChannelDescriptor::getName() — Method in class NotificationChannelDescriptor
- The full REST resource name for this descriptor. The syntax is:
projects/[PROJECT_ID]/notificationChannelDescriptors/[TYPE]
In the above,
[TYPE]is the value of thetypefield. - NotificationChannelDescriptor::getType() — Method in class NotificationChannelDescriptor
- The type of notification channel, such as "email", "sms", etc.
- NotificationChannelDescriptor::getDisplayName() — Method in class NotificationChannelDescriptor
- A human-readable name for the notification channel type. This form of the name is suitable for a user interface.
- NotificationChannelDescriptor::getDescription() — Method in class NotificationChannelDescriptor
- A human-readable description of the notification channel type. The description may include a description of the properties of the channel and pointers to external documentation.
- NotificationChannelDescriptor::getLabels() — Method in class NotificationChannelDescriptor
- The set of labels that must be defined to identify a particular channel of the corresponding type. Each label includes a description for how that field should be populated.
- NotificationChannelDescriptor::getSupportedTiers() — Method in class NotificationChannelDescriptor
- The tiers that support this notification channel; the project service tier must be one of the supported_tiers.
- NotificationChannelServiceGrpcClient::GetNotificationChannelDescriptor() — Method in class NotificationChannelServiceGrpcClient
- Gets a single channel descriptor. The descriptor indicates which fields are expected / permitted for a notification channel of the given type.
- NotificationChannelServiceGrpcClient::GetNotificationChannel() — Method in class NotificationChannelServiceGrpcClient
- Gets a single notification channel. The channel includes the relevant configuration details with which the channel was created. However, the response may truncate or omit passwords, API keys, or other private key matter and thus the response may not be 100% identical to the information that was supplied in the call to the create method.
- NotificationChannelServiceGrpcClient::GetNotificationChannelVerificationCode() — Method in class NotificationChannelServiceGrpcClient
- Requests a verification code for an already verified channel that can then be used in a call to VerifyNotificationChannel() on a different channel with an equivalent identity in the same or in a different project. This makes it possible to copy a channel between projects without requiring manual reverification of the channel. If the channel is not in the verified state, this method will fail (in other words, this may only be used if the SendNotificationChannelVerificationCode and VerifyNotificationChannel paths have already been used to put the given channel into the verified state).
- Point::getInterval() — Method in class Point
- The time interval to which the data point applies. For GAUGE metrics, only the end time of the interval is used. For DELTA metrics, the start and end time should specify a non-zero interval, with subsequent points specifying contiguous and non-overlapping intervals. For CUMULATIVE metrics, the start and end time should specify a non-zero interval, with subsequent points specifying the same start time and increasing end times, until an event resets the cumulative value to zero and sets a new start time for the following points.
- Point::getValue() — Method in class Point
- The value of the data point.
- SendNotificationChannelVerificationCodeRequest::getName() — Method in class SendNotificationChannelVerificationCodeRequest
- The notification channel to which to send a verification code.
- TimeInterval::getEndTime() — Method in class TimeInterval
- Required. The end of the time interval.
- TimeInterval::getStartTime() — Method in class TimeInterval
- Optional. The beginning of the time interval. The default value for the start time is the end time. The start time must not be later than the end time.
- TimeSeries::getMetric() — Method in class TimeSeries
- The associated metric. A fully-specified metric used to identify the time series.
- TimeSeries::getResource() — Method in class TimeSeries
- The associated resource. A fully-specified monitored resource used to identify the time series.
- TimeSeries::getMetricKind() — Method in class TimeSeries
- The metric kind of the time series. When listing time series, this metric kind might be different from the metric kind of the associated metric if this time series is an alignment or reduction of other time series.
- TimeSeries::getValueType() — Method in class TimeSeries
- The value type of the time series. When listing time series, this value type might be different from the value type of the associated metric if this time series is an alignment or reduction of other time series.
- TimeSeries::getPoints() — Method in class TimeSeries
- The data points of this time series. When listing time series, the order of the points is specified by the list method.
- TypedValue::getBoolValue() — Method in class TypedValue
- A Boolean value:
trueorfalse. - TypedValue::getInt64Value() — Method in class TypedValue
- A 64-bit integer. Its range is approximately ±9.2x1018.
- TypedValue::getDoubleValue() — Method in class TypedValue
- A 64-bit double-precision floating-point number. Its magnitude is approximately ±10±300 and it has 16 significant digits of precision.
- TypedValue::getStringValue() — Method in class TypedValue
- A variable-length string value.
- TypedValue::getDistributionValue() — Method in class TypedValue
- A distribution value.
- TypedValue::getValue() — Method in class TypedValue
- UpdateAlertPolicyRequest::getUpdateMask() — Method in class UpdateAlertPolicyRequest
- Optional. A list of alerting policy field names. If this field is not
empty, each listed field in the existing alerting policy is set to the
value of the corresponding field in the supplied policy (
alert_policy), or to the field's default value if the field is not in the supplied alerting policy. Fields not listed retain their previous value. - UpdateAlertPolicyRequest::getAlertPolicy() — Method in class UpdateAlertPolicyRequest
- Required. The updated alerting policy or the updated values for the
fields listed in
update_mask. - UpdateGroupRequest::getGroup() — Method in class UpdateGroupRequest
- The new definition of the group. All fields of the existing group,
excepting
name, are replaced with the corresponding fields of this group. - UpdateGroupRequest::getValidateOnly() — Method in class UpdateGroupRequest
- If true, validate this request but do not update the existing group.
- UpdateNotificationChannelRequest::getUpdateMask() — Method in class UpdateNotificationChannelRequest
- The fields to update.
- UpdateNotificationChannelRequest::getNotificationChannel() — Method in class UpdateNotificationChannelRequest
- A description of the changes to be applied to the specified
notification channel. The description must provide a definition for
fields to be updated; the names of these fields should also be
included in the
update_mask. - UpdateUptimeCheckConfigRequest::getUpdateMask() — Method in class UpdateUptimeCheckConfigRequest
- Optional. If present, only the listed fields in the current uptime check configuration are updated with values from the new configuration. If this field is empty, then the current configuration is completely replaced with the new configuration.
- UpdateUptimeCheckConfigRequest::getUptimeCheckConfig() — Method in class UpdateUptimeCheckConfigRequest
- Required. If an
"updateMask"has been specified, this field gives the values for the set of fields mentioned in the"updateMask". If an"updateMask"has not been given, this uptime check configuration replaces the current configuration. If a field is mentioned in"updateMask" but the corresonding field is omitted in this partial uptime check configuration, it has the effect of deleting/clearing the field from the configuration on the server. - UptimeCheckConfig::getName() — Method in class UptimeCheckConfig
- A unique resource name for this UptimeCheckConfig. The format is:
projects/[PROJECT_ID]/uptimeCheckConfigs/[UPTIME_CHECK_ID]. - UptimeCheckConfig::getDisplayName() — Method in class UptimeCheckConfig
- A human-friendly name for the uptime check configuration. The display name should be unique within a Stackdriver Account in order to make it easier to identify; however, uniqueness is not enforced. Required.
- UptimeCheckConfig::getMonitoredResource() — Method in class UptimeCheckConfig
- The monitored resource associated with the configuration.
- UptimeCheckConfig::getResourceGroup() — Method in class UptimeCheckConfig
- The group resource associated with the configuration.
- UptimeCheckConfig::getHttpCheck() — Method in class UptimeCheckConfig
- Contains information needed to make an HTTP or HTTPS check.
- UptimeCheckConfig::getTcpCheck() — Method in class UptimeCheckConfig
- Contains information needed to make a TCP check.
- UptimeCheckConfig::getPeriod() — Method in class UptimeCheckConfig
- How often the uptime check is performed.
- UptimeCheckConfig::getTimeout() — Method in class UptimeCheckConfig
- The maximum amount of time to wait for the request to complete (must be between 1 and 60 seconds). Required.
- UptimeCheckConfig::getContentMatchers() — Method in class UptimeCheckConfig
- The expected content on the page the check is run against.
- UptimeCheckConfig::getSelectedRegions() — Method in class UptimeCheckConfig
- The list of regions from which the check will be run.
- UptimeCheckConfig::getInternalCheckers() — Method in class UptimeCheckConfig
- The internal checkers that this check will egress from.
- UptimeCheckConfig::getResource() — Method in class UptimeCheckConfig
- UptimeCheckConfig::getCheckRequestType() — Method in class UptimeCheckConfig
- UptimeCheckConfig_ContentMatcher::getContent() — Method in class UptimeCheckConfig_ContentMatcher
- String content to match
- UptimeCheckConfig_HttpCheck::getUseSsl() — Method in class UptimeCheckConfig_HttpCheck
- If true, use HTTPS instead of HTTP to run the check.
- UptimeCheckConfig_HttpCheck::getPath() — Method in class UptimeCheckConfig_HttpCheck
- The path to the page to run the check against. Will be combined with the host (specified within the MonitoredResource) and port to construct the full URL. Optional (defaults to "/").
- UptimeCheckConfig_HttpCheck::getPort() — Method in class UptimeCheckConfig_HttpCheck
- The port to the page to run the check against. Will be combined with host (specified within the MonitoredResource) and path to construct the full URL. Optional (defaults to 80 without SSL, or 443 with SSL).
- UptimeCheckConfig_HttpCheck::getAuthInfo() — Method in class UptimeCheckConfig_HttpCheck
- The authentication information. Optional when creating an HTTP check; defaults to empty.
- UptimeCheckConfig_HttpCheck::getMaskHeaders() — Method in class UptimeCheckConfig_HttpCheck
- Boolean specifiying whether to encrypt the header information.
- UptimeCheckConfig_HttpCheck::getHeaders() — Method in class UptimeCheckConfig_HttpCheck
- The list of headers to send as part of the uptime check request.
- UptimeCheckConfig_HttpCheck_BasicAuthentication::getUsername() — Method in class UptimeCheckConfig_HttpCheck_BasicAuthentication
- The username to authenticate.
- UptimeCheckConfig_HttpCheck_BasicAuthentication::getPassword() — Method in class UptimeCheckConfig_HttpCheck_BasicAuthentication
- The password to authenticate.
- UptimeCheckConfig_InternalChecker::getProjectId() — Method in class UptimeCheckConfig_InternalChecker
- The GCP project ID. Not necessarily the same as the project_id for the config.
- UptimeCheckConfig_InternalChecker::getNetwork() — Method in class UptimeCheckConfig_InternalChecker
- The internal network to perform this uptime check on.
- UptimeCheckConfig_InternalChecker::getGcpZone() — Method in class UptimeCheckConfig_InternalChecker
- The GCP zone the uptime check should egress from. Only respected for internal uptime checks, where internal_network is specified.
- UptimeCheckConfig_InternalChecker::getCheckerId() — Method in class UptimeCheckConfig_InternalChecker
- The checker ID.
- UptimeCheckConfig_InternalChecker::getDisplayName() — Method in class UptimeCheckConfig_InternalChecker
- The checker's human-readable name.
- UptimeCheckConfig_ResourceGroup::getGroupId() — Method in class UptimeCheckConfig_ResourceGroup
- The group of resources being monitored. Should be only the
group_id, not projects/
/groups/ . - UptimeCheckConfig_ResourceGroup::getResourceType() — Method in class UptimeCheckConfig_ResourceGroup
- The resource type of the group members.
- UptimeCheckConfig_TcpCheck::getPort() — Method in class UptimeCheckConfig_TcpCheck
- The port to the page to run the check against. Will be combined with host (specified within the MonitoredResource) to construct the full URL.
- UptimeCheckIp::getRegion() — Method in class UptimeCheckIp
- A broad region category in which the IP address is located.
- UptimeCheckIp::getLocation() — Method in class UptimeCheckIp
- A more specific location within the region that typically encodes a particular city/town/metro (and its containing state/province or country) within the broader umbrella region category.
- UptimeCheckIp::getIpAddress() — Method in class UptimeCheckIp
- The IP address from which the uptime check originates. This is a full IP address (not an IP address range). Most IP addresses, as of this publication, are in IPv4 format; however, one should not rely on the IP addresses being in IPv4 format indefinitely and should support interpreting this field in either IPv4 or IPv6 format.
- UptimeCheckServiceGrpcClient::GetUptimeCheckConfig() — Method in class UptimeCheckServiceGrpcClient
- Gets a single uptime check configuration.
- VerifyNotificationChannelRequest::getName() — Method in class VerifyNotificationChannelRequest
- The notification channel to verify.
- VerifyNotificationChannelRequest::getCode() — Method in class VerifyNotificationChannelRequest
- The verification code that was delivered to the channel as
a result of invoking the
SendNotificationChannelVerificationCodeAPI method or that was retrieved from a verified channel viaGetNotificationChannelVerificationCode. For example, one might have "G-123456" or "TKNZGhhd2EyN3I1MnRnMjRv" (in general, one is only guaranteed that the code is valid UTF-8; one should not make any assumptions regarding the structure or format of the code). - PosixAccount::getPrimary() — Method in class PosixAccount
- Only one POSIX account can be marked as primary.
- PosixAccount::getUsername() — Method in class PosixAccount
- The username of the POSIX account.
- PosixAccount::getUid() — Method in class PosixAccount
- The user ID.
- PosixAccount::getGid() — Method in class PosixAccount
- The default group ID.
- PosixAccount::getHomeDirectory() — Method in class PosixAccount
- The path to the home directory for this account.
- PosixAccount::getShell() — Method in class PosixAccount
- The path to the logic shell for this account.
- PosixAccount::getGecos() — Method in class PosixAccount
- The GECOS (user information) entry for this account.
- PosixAccount::getSystemId() — Method in class PosixAccount
- System identifier for which account the username or uid applies to.
- PosixAccount::getAccountId() — Method in class PosixAccount
- Output only. A POSIX account identifier.
- SshPublicKey::getKey() — Method in class SshPublicKey
- Public key text in SSH format, defined by RFC4253 section 6.6.
- SshPublicKey::getExpirationTimeUsec() — Method in class SshPublicKey
- An expiration time in microseconds since epoch.
- SshPublicKey::getFingerprint() — Method in class SshPublicKey
- Output only. The SHA-256 fingerprint of the SSH public key.
- DeletePosixAccountRequest::getName() — Method in class DeletePosixAccountRequest
- A reference to the POSIX account to update. POSIX accounts are identified
by the project ID they are associated with. A reference to the POSIX
account is in format
users/{user}/projects/{project}. - DeleteSshPublicKeyRequest::getName() — Method in class DeleteSshPublicKeyRequest
- The fingerprint of the public key to update. Public keys are identified by
their SHA-256 fingerprint. The fingerprint of the public key is in format
users/{user}/sshPublicKeys/{fingerprint}. - GetLoginProfileRequest — Class in namespace Google\Cloud\OsLogin\V1beta
- A request message for retrieving the login profile information for a user.
- GetLoginProfileRequest::getName() — Method in class GetLoginProfileRequest
- The unique ID for the user in format
users/{user}. - GetSshPublicKeyRequest — Class in namespace Google\Cloud\OsLogin\V1beta
- A request message for retrieving an SSH public key.
- GetSshPublicKeyRequest::getName() — Method in class GetSshPublicKeyRequest
- The fingerprint of the public key to retrieve. Public keys are identified
by their SHA-256 fingerprint. The fingerprint of the public key is in
format
users/{user}/sshPublicKeys/{fingerprint}. - ImportSshPublicKeyRequest::getParent() — Method in class ImportSshPublicKeyRequest
- The unique ID for the user in format
users/{user}. - ImportSshPublicKeyRequest::getSshPublicKey() — Method in class ImportSshPublicKeyRequest
- The SSH public key and expiration time.
- ImportSshPublicKeyRequest::getProjectId() — Method in class ImportSshPublicKeyRequest
- The project ID of the Google Cloud Platform project.
- ImportSshPublicKeyResponse::getLoginProfile() — Method in class ImportSshPublicKeyResponse
- The login profile information for the user.
- LoginProfile::getName() — Method in class LoginProfile
- The primary email address that uniquely identifies the user.
- LoginProfile::getPosixAccounts() — Method in class LoginProfile
- The list of POSIX accounts associated with the user.
- LoginProfile::getSshPublicKeys() — Method in class LoginProfile
- A map from SSH public key fingerprint to the associated key object.
- LoginProfile::getSuspended() — Method in class LoginProfile
- Indicates if the user is suspended. A suspended user cannot log in but their profile information is retained.
- OsLoginServiceGrpcClient::GetLoginProfile() — Method in class OsLoginServiceGrpcClient
- Retrieves the profile information used for logging in to a virtual machine on Google Compute Engine.
- OsLoginServiceGrpcClient::GetSshPublicKey() — Method in class OsLoginServiceGrpcClient
- Retrieves an SSH public key.
- UpdateSshPublicKeyRequest::getName() — Method in class UpdateSshPublicKeyRequest
- The fingerprint of the public key to update. Public keys are identified by
their SHA-256 fingerprint. The fingerprint of the public key is in format
users/{user}/sshPublicKeys/{fingerprint}. - UpdateSshPublicKeyRequest::getSshPublicKey() — Method in class UpdateSshPublicKeyRequest
- The SSH public key and expiration time.
- UpdateSshPublicKeyRequest::getUpdateMask() — Method in class UpdateSshPublicKeyRequest
- Mask to control which fields get updated. Updates all if not present.
- AcknowledgeRequest::getSubscription() — Method in class AcknowledgeRequest
- The subscription whose message is being acknowledged.
- AcknowledgeRequest::getAckIds() — Method in class AcknowledgeRequest
- The acknowledgment ID for the messages being acknowledged that was returned
by the Pub/Sub system in the
Pullresponse. Must not be empty. - CreateSnapshotRequest::getName() — Method in class CreateSnapshotRequest
- Optional user-provided name for this snapshot.
- CreateSnapshotRequest::getSubscription() — Method in class CreateSnapshotRequest
- The subscription whose backlog the snapshot retains.
- DeleteSnapshotRequest::getSnapshot() — Method in class DeleteSnapshotRequest
- The name of the snapshot to delete.
- DeleteSubscriptionRequest::getSubscription() — Method in class DeleteSubscriptionRequest
- The subscription to delete.
- DeleteTopicRequest::getTopic() — Method in class DeleteTopicRequest
- Name of the topic to delete.
- GetSubscriptionRequest — Class in namespace Google\Cloud\PubSub\V1
- Request for the GetSubscription method.
- GetSubscriptionRequest::getSubscription() — Method in class GetSubscriptionRequest
- The name of the subscription to get.
- GetTopicRequest — Class in namespace Google\Cloud\PubSub\V1
- Request for the GetTopic method.
- GetTopicRequest::getTopic() — Method in class GetTopicRequest
- The name of the topic to get.
- ListSnapshotsRequest::getProject() — Method in class ListSnapshotsRequest
- The name of the cloud project that snapshots belong to.
- ListSnapshotsRequest::getPageSize() — Method in class ListSnapshotsRequest
- Maximum number of snapshots to return.
- ListSnapshotsRequest::getPageToken() — Method in class ListSnapshotsRequest
- The value returned by the last
ListSnapshotsResponse; indicates that this is a continuation of a priorListSnapshotscall, and that the system should return the next page of data. - ListSnapshotsResponse::getSnapshots() — Method in class ListSnapshotsResponse
- The resulting snapshots.
- ListSnapshotsResponse::getNextPageToken() — Method in class ListSnapshotsResponse
- If not empty, indicates that there may be more snapshot that match the
request; this value should be passed in a new
ListSnapshotsRequest. - ListSubscriptionsRequest::getProject() — Method in class ListSubscriptionsRequest
- The name of the cloud project that subscriptions belong to.
- ListSubscriptionsRequest::getPageSize() — Method in class ListSubscriptionsRequest
- Maximum number of subscriptions to return.
- ListSubscriptionsRequest::getPageToken() — Method in class ListSubscriptionsRequest
- The value returned by the last
ListSubscriptionsResponse; indicates that this is a continuation of a priorListSubscriptionscall, and that the system should return the next page of data. - ListSubscriptionsResponse::getSubscriptions() — Method in class ListSubscriptionsResponse
- The subscriptions that match the request.
- ListSubscriptionsResponse::getNextPageToken() — Method in class ListSubscriptionsResponse
- If not empty, indicates that there may be more subscriptions that match
the request; this value should be passed in a new
ListSubscriptionsRequestto get more subscriptions. - ListTopicSubscriptionsRequest::getTopic() — Method in class ListTopicSubscriptionsRequest
- The name of the topic that subscriptions are attached to.
- ListTopicSubscriptionsRequest::getPageSize() — Method in class ListTopicSubscriptionsRequest
- Maximum number of subscription names to return.
- ListTopicSubscriptionsRequest::getPageToken() — Method in class ListTopicSubscriptionsRequest
- The value returned by the last
ListTopicSubscriptionsResponse; indicates that this is a continuation of a priorListTopicSubscriptionscall, and that the system should return the next page of data. - ListTopicSubscriptionsResponse::getSubscriptions() — Method in class ListTopicSubscriptionsResponse
- The names of the subscriptions that match the request.
- ListTopicSubscriptionsResponse::getNextPageToken() — Method in class ListTopicSubscriptionsResponse
- If not empty, indicates that there may be more subscriptions that match
the request; this value should be passed in a new
ListTopicSubscriptionsRequestto get more subscriptions. - ListTopicsRequest::getProject() — Method in class ListTopicsRequest
- The name of the cloud project that topics belong to.
- ListTopicsRequest::getPageSize() — Method in class ListTopicsRequest
- Maximum number of topics to return.
- ListTopicsRequest::getPageToken() — Method in class ListTopicsRequest
- The value returned by the last
ListTopicsResponse; indicates that this is a continuation of a priorListTopicscall, and that the system should return the next page of data. - ListTopicsResponse::getTopics() — Method in class ListTopicsResponse
- The resulting topics.
- ListTopicsResponse::getNextPageToken() — Method in class ListTopicsResponse
- If not empty, indicates that there may be more topics that match the
request; this value should be passed in a new
ListTopicsRequest. - ModifyAckDeadlineRequest::getSubscription() — Method in class ModifyAckDeadlineRequest
- The name of the subscription.
- ModifyAckDeadlineRequest::getAckIds() — Method in class ModifyAckDeadlineRequest
- List of acknowledgment IDs.
- ModifyAckDeadlineRequest::getAckDeadlineSeconds() — Method in class ModifyAckDeadlineRequest
- The new ack deadline with respect to the time this request was sent to
the Pub/Sub system. For example, if the value is 10, the new
ack deadline will expire 10 seconds after the
ModifyAckDeadlinecall was made. Specifying zero may immediately make the message available for another pull request. - ModifyPushConfigRequest::getSubscription() — Method in class ModifyPushConfigRequest
- The name of the subscription.
- ModifyPushConfigRequest::getPushConfig() — Method in class ModifyPushConfigRequest
- The push configuration for future deliveries.
- PublishRequest::getTopic() — Method in class PublishRequest
- The messages in the request will be published on this topic.
- PublishRequest::getMessages() — Method in class PublishRequest
- The messages to publish.
- PublishResponse::getMessageIds() — Method in class PublishResponse
- The server-assigned ID of each published message, in the same order as the messages in the request. IDs are guaranteed to be unique within the topic.
- PublisherGrpcClient::GetTopic() — Method in class PublisherGrpcClient
- Gets the configuration of a topic.
- PubsubMessage::getData() — Method in class PubsubMessage
- The message payload.
- PubsubMessage::getAttributes() — Method in class PubsubMessage
- Optional attributes for this message.
- PubsubMessage::getMessageId() — Method in class PubsubMessage
- ID of this message, assigned by the server when the message is published.
- PubsubMessage::getPublishTime() — Method in class PubsubMessage
- The time at which the message was published, populated by the server when
it receives the
Publishcall. It must not be populated by the publisher in aPublishcall. - PullRequest::getSubscription() — Method in class PullRequest
- The subscription from which messages should be pulled.
- PullRequest::getReturnImmediately() — Method in class PullRequest
- If this field set to true, the system will respond immediately even if
it there are no messages available to return in the
Pullresponse. - PullRequest::getMaxMessages() — Method in class PullRequest
- The maximum number of messages returned for this request. The Pub/Sub system may return fewer than the number specified.
- PullResponse::getReceivedMessages() — Method in class PullResponse
- Received Pub/Sub messages. The Pub/Sub system will return zero messages if
there are no more available in the backlog. The Pub/Sub system may return
fewer than the
maxMessagesrequested even if there are more messages available in the backlog. - PushConfig::getPushEndpoint() — Method in class PushConfig
- A URL locating the endpoint to which messages should be pushed.
- PushConfig::getAttributes() — Method in class PushConfig
- Endpoint configuration attributes.
- ReceivedMessage::getAckId() — Method in class ReceivedMessage
- This ID can be used to acknowledge the received message.
- ReceivedMessage::getMessage() — Method in class ReceivedMessage
- The message.
- SeekRequest::getSubscription() — Method in class SeekRequest
- The subscription to affect.
- SeekRequest::getTime() — Method in class SeekRequest
- The time to seek to.
- SeekRequest::getSnapshot() — Method in class SeekRequest
- The snapshot to seek to. The snapshot's topic must be the same as that of the provided subscription.
- SeekRequest::getTarget() — Method in class SeekRequest
- Snapshot::getName() — Method in class Snapshot
- The name of the snapshot.
- Snapshot::getTopic() — Method in class Snapshot
- The name of the topic from which this snapshot is retaining messages.
- Snapshot::getExpireTime() — Method in class Snapshot
- The snapshot is guaranteed to exist up until this time.
- Snapshot::getLabels() — Method in class Snapshot
- User labels.
- StreamingPullRequest::getSubscription() — Method in class StreamingPullRequest
- The subscription for which to initialize the new stream. This must be provided in the first request on the stream, and must not be set in subsequent requests from client to server.
- StreamingPullRequest::getAckIds() — Method in class StreamingPullRequest
- List of acknowledgement IDs for acknowledging previously received messages
(received on this stream or a different stream). If an ack ID has expired,
the corresponding message may be redelivered later. Acknowledging a message
more than once will not result in an error. If the acknowledgement ID is
malformed, the stream will be aborted with status
INVALID_ARGUMENT. - StreamingPullRequest::getModifyDeadlineSeconds() — Method in class StreamingPullRequest
- The list of new ack deadlines for the IDs listed in
modify_deadline_ack_ids. The size of this list must be the same as the size ofmodify_deadline_ack_ids. If it differs the stream will be aborted withINVALID_ARGUMENT. Each element in this list is applied to the element in the same position inmodify_deadline_ack_ids. The new ack deadline is with respect to the time this request was sent to the Pub/Sub system. Must be >= 0. For example, if the value is 10, the new ack deadline will expire 10 seconds after this request is received. If the value is 0, the message is immediately made available for another streaming or non-streaming pull request. If the value is < 0 (an error), the stream will be aborted with statusINVALID_ARGUMENT. - StreamingPullRequest::getModifyDeadlineAckIds() — Method in class StreamingPullRequest
- List of acknowledgement IDs whose deadline will be modified based on the
corresponding element in
modify_deadline_seconds. This field can be used to indicate that more time is needed to process a message by the subscriber, or to make the message available for redelivery if the processing was interrupted. - StreamingPullRequest::getStreamAckDeadlineSeconds() — Method in class StreamingPullRequest
- The ack deadline to use for the stream. This must be provided in the first request on the stream, but it can also be updated on subsequent requests from client to server. The minimum deadline you can specify is 10 seconds. The maximum deadline you can specify is 600 seconds (10 minutes).
- StreamingPullResponse::getReceivedMessages() — Method in class StreamingPullResponse
- Received Pub/Sub messages. This will not be empty.
- SubscriberGrpcClient::GetSubscription() — Method in class SubscriberGrpcClient
- Gets the configuration details of a subscription.
- Subscription::getName() — Method in class Subscription
- The name of the subscription. It must have the format
"projects/{project}/subscriptions/{subscription}".{subscription}must start with a letter, and contain only letters ([A-Za-z]), numbers ([0-9]), dashes (-), underscores (_), periods (.), tildes (~), plus (+) or percent signs (%). It must be between 3 and 255 characters in length, and it must not start with"goog". - Subscription::getTopic() — Method in class Subscription
- The name of the topic from which this subscription is receiving messages.
- Subscription::getPushConfig() — Method in class Subscription
- If push delivery is used with this subscription, this field is
used to configure it. An empty
pushConfigsignifies that the subscriber will pull and ack messages using API methods. - Subscription::getAckDeadlineSeconds() — Method in class Subscription
- This value is the maximum time after a subscriber receives a message before the subscriber should acknowledge the message. After message delivery but before the ack deadline expires and before the message is acknowledged, it is an outstanding message and will not be delivered again during that time (on a best-effort basis).
- Subscription::getRetainAckedMessages() — Method in class Subscription
- Indicates whether to retain acknowledged messages. If true, then
messages are not expunged from the subscription's backlog, even if they are
acknowledged, until they fall out of the
message_retention_durationwindow. - Subscription::getMessageRetentionDuration() — Method in class Subscription
- How long to retain unacknowledged messages in the subscription's backlog, from the moment a message is published.
- Subscription::getLabels() — Method in class Subscription
- User labels.
- Topic::getName() — Method in class Topic
- The name of the topic. It must have the format
"projects/{project}/topics/{topic}".{topic}must start with a letter, and contain only letters ([A-Za-z]), numbers ([0-9]), dashes (-), underscores (_), periods (.), tildes (~), plus (+) or percent signs (%). It must be between 3 and 255 characters in length, and it must not start with"goog". - Topic::getLabels() — Method in class Topic
- User labels.
- UpdateSnapshotRequest::getSnapshot() — Method in class UpdateSnapshotRequest
- The updated snpashot object.
- UpdateSnapshotRequest::getUpdateMask() — Method in class UpdateSnapshotRequest
- Indicates which fields in the provided snapshot to update.
- UpdateSubscriptionRequest::getSubscription() — Method in class UpdateSubscriptionRequest
- The updated subscription object.
- UpdateSubscriptionRequest::getUpdateMask() — Method in class UpdateSubscriptionRequest
- Indicates which fields in the provided subscription to update.
- UpdateTopicRequest::getTopic() — Method in class UpdateTopicRequest
- The topic to update.
- UpdateTopicRequest::getUpdateMask() — Method in class UpdateTopicRequest
- Indicates which fields in the provided topic to update.
- CloudRedisGrpcClient::GetInstance() — Method in class CloudRedisGrpcClient
- Gets the details of a specific Redis instance.
- CreateInstanceRequest::getParent() — Method in class CreateInstanceRequest
- Required. The resource name of the instance location using the form:
projects/{project_id}/locations/{location_id}wherelocation_idrefers to a GCP region - CreateInstanceRequest::getInstanceId() — Method in class CreateInstanceRequest
- Required. The logical name of the Redis instance in the customer project with the following restrictions: * Must contain only lowercase letters, numbers, and hyphens.
- CreateInstanceRequest::getInstance() — Method in class CreateInstanceRequest
- Required. A Redis [Instance] resource
- DeleteInstanceRequest::getName() — Method in class DeleteInstanceRequest
- Required. Redis instance resource name using the form:
projects/{project_id}/locations/{location_id}/instances/{instance_id}wherelocation_idrefers to a GCP region - GetInstanceRequest — Class in namespace Google\Cloud\Redis\V1beta1
- Request for [GetInstance][google.cloud.redis.v1beta1.CloudRedis.GetInstance].
- GetInstanceRequest::getName() — Method in class GetInstanceRequest
- Required. Redis instance resource name using the form:
projects/{project_id}/locations/{location_id}/instances/{instance_id}wherelocation_idrefers to a GCP region - Instance::getName() — Method in class Instance
- Required. Unique name of the resource in this scope including project and
location using the form:
projects/{project_id}/locations/{location_id}/instances/{instance_id}Note: Redis instances are managed and addressed at regional level so location_id here refers to a GCP region; however, users get to choose which specific zone (or collection of zones for cross-zone instances) an instance should be provisioned in. Refer to [location_id] and [alternative_location_id] fields for more details. - Instance::getDisplayName() — Method in class Instance
- An arbitrary and optional user-provided name for the instance.
- Instance::getLabels() — Method in class Instance
- Resource labels to represent user provided metadata
- Instance::getLocationId() — Method in class Instance
- Optional. The zone where the instance will be provisioned. If not provided, the service will choose a zone for the instance. For STANDARD_HA tier, instances will be created across two zones for protection against zonal failures. if [alternative_location_id] is also provided, it must be different from [location_id].
- Instance::getAlternativeLocationId() — Method in class Instance
- Optional. Only applicable to STANDARD_HA tier which protects the instance against zonal failures by provisioning it across two zones. If provided, it must be a different zone from the one provided in [location_id].
- Instance::getRedisVersion() — Method in class Instance
- Optional. The version of Redis software.
- Instance::getReservedIpRange() — Method in class Instance
- Optional. The CIDR range of internal addresses that are reserved for this instance. If not provided, the service will choose an unused /29 block, for example, 10.0.0.0/29 or 192.168.0.0/29. Ranges must be unique and non-overlapping with existing subnets in a network.
- Instance::getHost() — Method in class Instance
- Output only. Hostname or IP address of the exposed redis endpoint used by clients to connect to the service.
- Instance::getPort() — Method in class Instance
- Output only. The port number of the exposed redis endpoint.
- Instance::getCurrentLocationId() — Method in class Instance
- Output only. The current zone where the Redis endpoint is placed. In single zone deployments, this will always be the same as [location_id] provided by the user at creation time. In cross-zone instances (only applicable in STANDARD_HA tier), this can be either [location_id] or [alternative_location_id] and can change on a failover event.
- Instance::getCreateTime() — Method in class Instance
- Output only. The time the instance was created.
- Instance::getState() — Method in class Instance
- Output only. The current state of this instance.
- Instance::getStatusMessage() — Method in class Instance
- Output only. Additional information about the current status of this instance, if available.
- Instance::getRedisConfigs() — Method in class Instance
- Optional. Redis configuration parameters, according to http://redis.io/topics/config. Currently, the only supported parameters are: * maxmemory-policy * notify-keyspace-events
- Instance::getTier() — Method in class Instance
- Required. The service tier of the instance.
- Instance::getMemorySizeGb() — Method in class Instance
- Required. Redis memory size in GB.
- Instance::getAuthorizedNetwork() — Method in class Instance
- Optional. The full name of the Google Compute Engine
network to which the
instance is connected. If left unspecified, the
defaultnetwork will be used. - ListInstancesRequest::getParent() — Method in class ListInstancesRequest
- Required. The resource name of the instance location using the form:
projects/{project_id}/locations/{location_id}wherelocation_idrefers to a GCP region - ListInstancesRequest::getPageSize() — Method in class ListInstancesRequest
- The maximum number of items to return.
- ListInstancesRequest::getPageToken() — Method in class ListInstancesRequest
- The next_page_token value returned from a previous List request, if any.
- ListInstancesResponse::getInstances() — Method in class ListInstancesResponse
- A list of Redis instances in the project in the specified location, or across all locations.
- ListInstancesResponse::getNextPageToken() — Method in class ListInstancesResponse
- Token to retrieve the next page of results, or empty if there are no more results in the list.
- LocationMetadata::getAvailableZones() — Method in class LocationMetadata
- Output only. The set of available zones in the location. The map is keyed
by the lowercase ID of each zone, as defined by GCE. These keys can be
specified in
location_idoralternative_location_idfields when creating a Redis instance. - UpdateInstanceRequest::getUpdateMask() — Method in class UpdateInstanceRequest
- Required. Mask of fields to update. At least one path must be supplied in
this field. The elements of the repeated paths field may only include these
fields from [Instance][CloudRedis.Instance]:
*
display_name*labels*memory_size_gb*redis_config - UpdateInstanceRequest::getInstance() — Method in class UpdateInstanceRequest
- Required. Update description.
- CreateDatabaseMetadata::getDatabase() — Method in class CreateDatabaseMetadata
- The database being created.
- CreateDatabaseRequest::getParent() — Method in class CreateDatabaseRequest
- Required. The name of the instance that will serve the new database.
- CreateDatabaseRequest::getCreateStatement() — Method in class CreateDatabaseRequest
- Required. A
CREATE DATABASEstatement, which specifies the ID of the new database. The database ID must conform to the regular expression[a-z][a-z0-9_\-]*[a-z0-9]and be between 2 and 30 characters in length. - CreateDatabaseRequest::getExtraStatements() — Method in class CreateDatabaseRequest
- An optional list of DDL statements to run inside the newly created database. Statements can create tables, indexes, etc. These statements execute atomically with the creation of the database: if there is an error in any statement, the database is not created.
- Database::getName() — Method in class Database
- Required. The name of the database. Values are of the form
projects/<project>/instances/<instance>/databases/<database>, where<database>is as specified in theCREATE DATABASEstatement. This name can be passed to other API methods to identify the database. - Database::getState() — Method in class Database
- Output only. The current database state.
- DatabaseAdminGrpcClient::GetDatabase() — Method in class DatabaseAdminGrpcClient
- Gets the state of a Cloud Spanner database.
- DatabaseAdminGrpcClient::GetDatabaseDdl() — Method in class DatabaseAdminGrpcClient
- Returns the schema of a Cloud Spanner database as a list of formatted DDL statements. This method does not show pending schema updates, those may be queried using the [Operations][google.longrunning.Operations] API.
- DatabaseAdminGrpcClient::GetIamPolicy() — Method in class DatabaseAdminGrpcClient
- Gets the access control policy for a database resource. Returns an empty policy if a database exists but does not have a policy set.
- DropDatabaseRequest::getDatabase() — Method in class DropDatabaseRequest
- Required. The database to be dropped.
- GetDatabaseDdlRequest — Class in namespace Google\Cloud\Spanner\Admin\Database\V1
- The request for [GetDatabaseDdl][google.spanner.admin.database.v1.DatabaseAdmin.GetDatabaseDdl].
- GetDatabaseDdlRequest::getDatabase() — Method in class GetDatabaseDdlRequest
- Required. The database whose schema we wish to get.
- GetDatabaseDdlResponse — Class in namespace Google\Cloud\Spanner\Admin\Database\V1
- The response for [GetDatabaseDdl][google.spanner.admin.database.v1.DatabaseAdmin.GetDatabaseDdl].
- GetDatabaseDdlResponse::getStatements() — Method in class GetDatabaseDdlResponse
- A list of formatted DDL statements defining the schema of the database specified in the request.
- GetDatabaseRequest — Class in namespace Google\Cloud\Spanner\Admin\Database\V1
- The request for [GetDatabase][google.spanner.admin.database.v1.DatabaseAdmin.GetDatabase].
- GetDatabaseRequest::getName() — Method in class GetDatabaseRequest
- Required. The name of the requested database. Values are of the form
projects/<project>/instances/<instance>/databases/<database>. - ListDatabasesRequest::getParent() — Method in class ListDatabasesRequest
- Required. The instance whose databases should be listed.
- ListDatabasesRequest::getPageSize() — Method in class ListDatabasesRequest
- Number of databases to be returned in the response. If 0 or less, defaults to the server's maximum allowed page size.
- ListDatabasesRequest::getPageToken() — Method in class ListDatabasesRequest
- If non-empty,
page_tokenshould contain a [next_page_token][google.spanner.admin.database.v1.ListDatabasesResponse.next_page_token] from a previous [ListDatabasesResponse][google.spanner.admin.database.v1.ListDatabasesResponse]. - ListDatabasesResponse::getDatabases() — Method in class ListDatabasesResponse
- Databases that matched the request.
- ListDatabasesResponse::getNextPageToken() — Method in class ListDatabasesResponse
next_page_tokencan be sent in a subsequent [ListDatabases][google.spanner.admin.database.v1.DatabaseAdmin.ListDatabases] call to fetch more of the matching databases.- UpdateDatabaseDdlMetadata::getDatabase() — Method in class UpdateDatabaseDdlMetadata
- The database being modified.
- UpdateDatabaseDdlMetadata::getStatements() — Method in class UpdateDatabaseDdlMetadata
- For an update this list contains all the statements. For an individual statement, this list contains only that statement.
- UpdateDatabaseDdlMetadata::getCommitTimestamps() — Method in class UpdateDatabaseDdlMetadata
- Reports the commit timestamps of all statements that have
succeeded so far, where
commit_timestamps[i]is the commit timestamp for the statementstatements[i]. - UpdateDatabaseDdlRequest::getDatabase() — Method in class UpdateDatabaseDdlRequest
- Required. The database to update.
- UpdateDatabaseDdlRequest::getStatements() — Method in class UpdateDatabaseDdlRequest
- DDL statements to be applied to the database.
- UpdateDatabaseDdlRequest::getOperationId() — Method in class UpdateDatabaseDdlRequest
- If empty, the new update request is assigned an
automatically-generated operation ID. Otherwise,
operation_idis used to construct the name of the resulting [Operation][google.longrunning.Operation]. - CreateInstanceMetadata::getInstance() — Method in class CreateInstanceMetadata
- The instance being created.
- CreateInstanceMetadata::getStartTime() — Method in class CreateInstanceMetadata
- The time at which the [CreateInstance][google.spanner.admin.instance.v1.InstanceAdmin.CreateInstance] request was received.
- CreateInstanceMetadata::getCancelTime() — Method in class CreateInstanceMetadata
- The time at which this operation was cancelled. If set, this operation is in the process of undoing itself (which is guaranteed to succeed) and cannot be cancelled again.
- CreateInstanceMetadata::getEndTime() — Method in class CreateInstanceMetadata
- The time at which this operation failed or was completed successfully.
- CreateInstanceRequest::getParent() — Method in class CreateInstanceRequest
- Required. The name of the project in which to create the instance. Values
are of the form
projects/<project>. - CreateInstanceRequest::getInstanceId() — Method in class CreateInstanceRequest
- Required. The ID of the instance to create. Valid identifiers are of the
form
[a-z][-a-z0-9]*[a-z0-9]and must be between 6 and 30 characters in length. - CreateInstanceRequest::getInstance() — Method in class CreateInstanceRequest
- Required. The instance to create. The name may be omitted, but if
specified must be
<parent>/instances/<instance_id>. - DeleteInstanceRequest::getName() — Method in class DeleteInstanceRequest
- Required. The name of the instance to be deleted. Values are of the form
projects/<project>/instances/<instance> - GetInstanceConfigRequest — Class in namespace Google\Cloud\Spanner\Admin\Instance\V1
- The request for [GetInstanceConfigRequest][google.spanner.admin.instance.v1.InstanceAdmin.GetInstanceConfig].
- GetInstanceConfigRequest::getName() — Method in class GetInstanceConfigRequest
- Required. The name of the requested instance configuration. Values are of
the form
projects/<project>/instanceConfigs/<config>. - GetInstanceRequest — Class in namespace Google\Cloud\Spanner\Admin\Instance\V1
- The request for [GetInstance][google.spanner.admin.instance.v1.InstanceAdmin.GetInstance].
- GetInstanceRequest::getName() — Method in class GetInstanceRequest
- Required. The name of the requested instance. Values are of the form
projects/<project>/instances/<instance>. - Instance::getName() — Method in class Instance
- Required. A unique identifier for the instance, which cannot be changed
after the instance is created. Values are of the form
projects/<project>/instances/[a-z][-a-z0-9]*[a-z0-9]. The final segment of the name must be between 6 and 30 characters in length. - Instance::getConfig() — Method in class Instance
- Required. The name of the instance's configuration. Values are of the form
projects/<project>/instanceConfigs/<configuration>. See also [InstanceConfig][google.spanner.admin.instance.v1.InstanceConfig] and [ListInstanceConfigs][google.spanner.admin.instance.v1.InstanceAdmin.ListInstanceConfigs]. - Instance::getDisplayName() — Method in class Instance
- Required. The descriptive name for this instance as it appears in UIs.
- Instance::getNodeCount() — Method in class Instance
- Required. The number of nodes allocated to this instance. This may be zero
in API responses for instances that are not yet in state
READY. - Instance::getState() — Method in class Instance
- Output only. The current instance state. For
[CreateInstance][google.spanner.admin.instance.v1.InstanceAdmin.CreateInstance], the state must be
either omitted or set to
CREATING. For [UpdateInstance][google.spanner.admin.instance.v1.InstanceAdmin.UpdateInstance], the state must be either omitted or set toREADY. - Instance::getLabels() — Method in class Instance
- Cloud Labels are a flexible and lightweight mechanism for organizing cloud resources into groups that reflect a customer's organizational needs and deployment strategies. Cloud Labels can be used to filter collections of resources. They can be used to control how resource metrics are aggregated.
- InstanceAdminGrpcClient::GetInstanceConfig() — Method in class InstanceAdminGrpcClient
- Gets information about a particular instance configuration.
- InstanceAdminGrpcClient::GetInstance() — Method in class InstanceAdminGrpcClient
- Gets information about a particular instance.
- InstanceAdminGrpcClient::GetIamPolicy() — Method in class InstanceAdminGrpcClient
- Gets the access control policy for an instance resource. Returns an empty policy if an instance exists but does not have a policy set.
- InstanceConfig::getName() — Method in class InstanceConfig
- A unique identifier for the instance configuration. Values
are of the form
projects/<project>/instanceConfigs/[a-z][-a-z0-9]* - InstanceConfig::getDisplayName() — Method in class InstanceConfig
- The name of this instance configuration as it appears in UIs.
- ListInstanceConfigsRequest::getParent() — Method in class ListInstanceConfigsRequest
- Required. The name of the project for which a list of supported instance
configurations is requested. Values are of the form
projects/<project>. - ListInstanceConfigsRequest::getPageSize() — Method in class ListInstanceConfigsRequest
- Number of instance configurations to be returned in the response. If 0 or less, defaults to the server's maximum allowed page size.
- ListInstanceConfigsRequest::getPageToken() — Method in class ListInstanceConfigsRequest
- If non-empty,
page_tokenshould contain a [next_page_token][google.spanner.admin.instance.v1.ListInstanceConfigsResponse.next_page_token] from a previous [ListInstanceConfigsResponse][google.spanner.admin.instance.v1.ListInstanceConfigsResponse]. - ListInstanceConfigsResponse::getInstanceConfigs() — Method in class ListInstanceConfigsResponse
- The list of requested instance configurations.
- ListInstanceConfigsResponse::getNextPageToken() — Method in class ListInstanceConfigsResponse
next_page_tokencan be sent in a subsequent [ListInstanceConfigs][google.spanner.admin.instance.v1.InstanceAdmin.ListInstanceConfigs] call to fetch more of the matching instance configurations.- ListInstancesRequest::getParent() — Method in class ListInstancesRequest
- Required. The name of the project for which a list of instances is
requested. Values are of the form
projects/<project>. - ListInstancesRequest::getPageSize() — Method in class ListInstancesRequest
- Number of instances to be returned in the response. If 0 or less, defaults to the server's maximum allowed page size.
- ListInstancesRequest::getPageToken() — Method in class ListInstancesRequest
- If non-empty,
page_tokenshould contain a [next_page_token][google.spanner.admin.instance.v1.ListInstancesResponse.next_page_token] from a previous [ListInstancesResponse][google.spanner.admin.instance.v1.ListInstancesResponse]. - ListInstancesRequest::getFilter() — Method in class ListInstancesRequest
- An expression for filtering the results of the request. Filter rules are
case insensitive. The fields eligible for filtering are:
*
name*display_name*labels.keywhere key is the name of a label Some examples of using filters are: *name:*--> The instance has a name. - ListInstancesResponse::getInstances() — Method in class ListInstancesResponse
- The list of requested instances.
- ListInstancesResponse::getNextPageToken() — Method in class ListInstancesResponse
next_page_tokencan be sent in a subsequent [ListInstances][google.spanner.admin.instance.v1.InstanceAdmin.ListInstances] call to fetch more of the matching instances.- UpdateInstanceMetadata::getInstance() — Method in class UpdateInstanceMetadata
- The desired end state of the update.
- UpdateInstanceMetadata::getStartTime() — Method in class UpdateInstanceMetadata
- The time at which [UpdateInstance][google.spanner.admin.instance.v1.InstanceAdmin.UpdateInstance] request was received.
- UpdateInstanceMetadata::getCancelTime() — Method in class UpdateInstanceMetadata
- The time at which this operation was cancelled. If set, this operation is in the process of undoing itself (which is guaranteed to succeed) and cannot be cancelled again.
- UpdateInstanceMetadata::getEndTime() — Method in class UpdateInstanceMetadata
- The time at which this operation failed or was completed successfully.
- UpdateInstanceRequest::getInstance() — Method in class UpdateInstanceRequest
- Required. The instance to update, which must always include the instance name. Otherwise, only fields mentioned in [][google.spanner.admin.instance.v1.UpdateInstanceRequest.field_mask] need be included.
- UpdateInstanceRequest::getFieldMask() — Method in class UpdateInstanceRequest
- Required. A mask specifying which fields in [][google.spanner.admin.instance.v1.UpdateInstanceRequest.instance] should be updated.
- BeginTransactionRequest::getSession() — Method in class BeginTransactionRequest
- Required. The session in which the transaction runs.
- BeginTransactionRequest::getOptions() — Method in class BeginTransactionRequest
- Required. Options for the new transaction.
- CommitRequest::getSession() — Method in class CommitRequest
- Required. The session in which the transaction to be committed is running.
- CommitRequest::getTransactionId() — Method in class CommitRequest
- Commit a previously-started transaction.
- CommitRequest::getSingleUseTransaction() — Method in class CommitRequest
- Execute mutations in a temporary transaction. Note that unlike
commit of a previously-started transaction, commit with a
temporary transaction is non-idempotent. That is, if the
CommitRequestis sent to Cloud Spanner more than once (for instance, due to retries in the application, or in the transport library), it is possible that the mutations are executed more than once. If this is undesirable, use [BeginTransaction][google.spanner.v1.Spanner.BeginTransaction] and [Commit][google.spanner.v1.Spanner.Commit] instead. - CommitRequest::getMutations() — Method in class CommitRequest
- The mutations to be executed when this transaction commits. All mutations are applied atomically, in the order they appear in this list.
- CommitRequest::getTransaction() — Method in class CommitRequest
- CommitResponse::getCommitTimestamp() — Method in class CommitResponse
- The Cloud Spanner timestamp at which the transaction committed.
- CreateSessionRequest::getDatabase() — Method in class CreateSessionRequest
- Required. The database in which the new session is created.
- CreateSessionRequest::getSession() — Method in class CreateSessionRequest
- The session to create.
- DeleteSessionRequest::getName() — Method in class DeleteSessionRequest
- Required. The name of the session to delete.
- ExecuteSqlRequest::getSession() — Method in class ExecuteSqlRequest
- Required. The session in which the SQL query should be performed.
- ExecuteSqlRequest::getTransaction() — Method in class ExecuteSqlRequest
- The transaction to use. If none is provided, the default is a temporary read-only transaction with strong concurrency.
- ExecuteSqlRequest::getSql() — Method in class ExecuteSqlRequest
- Required. The SQL query string.
- ExecuteSqlRequest::getParams() — Method in class ExecuteSqlRequest
- The SQL query string can contain parameter placeholders. A parameter
placeholder consists of
'@'followed by the parameter name. Parameter names consist of any combination of letters, numbers, and underscores. - ExecuteSqlRequest::getParamTypes() — Method in class ExecuteSqlRequest
- It is not always possible for Cloud Spanner to infer the right SQL type
from a JSON value. For example, values of type
BYTESand values of typeSTRINGboth appear in [params][google.spanner.v1.ExecuteSqlRequest.params] as JSON strings. - ExecuteSqlRequest::getResumeToken() — Method in class ExecuteSqlRequest
- If this request is resuming a previously interrupted SQL query
execution,
resume_tokenshould be copied from the last [PartialResultSet][google.spanner.v1.PartialResultSet] yielded before the interruption. Doing this enables the new SQL query execution to resume where the last one left off. The rest of the request parameters must exactly match the request that yielded this token. - ExecuteSqlRequest::getQueryMode() — Method in class ExecuteSqlRequest
- Used to control the amount of debugging information returned in [ResultSetStats][google.spanner.v1.ResultSetStats]. If [partition_token][google.spanner.v1.ExecuteSqlRequest.partition_token] is set, [query_mode][google.spanner.v1.ExecuteSqlRequest.query_mode] can only be set to [QueryMode.NORMAL][google.spanner.v1.ExecuteSqlRequest.QueryMode.NORMAL].
- ExecuteSqlRequest::getPartitionToken() — Method in class ExecuteSqlRequest
- If present, results will be restricted to the specified partition previously created using PartitionQuery(). There must be an exact match for the values of fields common to this message and the PartitionQueryRequest message used to create this partition_token.
- GetSessionRequest — Class in namespace Google\Cloud\Spanner\V1
- The request for [GetSession][google.spanner.v1.Spanner.GetSession].
- GetSessionRequest::getName() — Method in class GetSessionRequest
- Required. The name of the session to retrieve.
- KeyRange::getStartClosed() — Method in class KeyRange
- If the start is closed, then the range includes all rows whose
first
len(start_closed)key columns exactly matchstart_closed. - KeyRange::getStartOpen() — Method in class KeyRange
- If the start is open, then the range excludes rows whose first
len(start_open)key columns exactly matchstart_open. - KeyRange::getEndClosed() — Method in class KeyRange
- If the end is closed, then the range includes all rows whose
first
len(end_closed)key columns exactly matchend_closed. - KeyRange::getEndOpen() — Method in class KeyRange
- If the end is open, then the range excludes rows whose first
len(end_open)key columns exactly matchend_open. - KeyRange::getStartKeyType() — Method in class KeyRange
- KeyRange::getEndKeyType() — Method in class KeyRange
- KeySet::getKeys() — Method in class KeySet
- A list of specific keys. Entries in
keysshould have exactly as many elements as there are columns in the primary or index key with which thisKeySetis used. Individual key values are encoded as described [here][google.spanner.v1.TypeCode]. - KeySet::getRanges() — Method in class KeySet
- A list of key ranges. See [KeyRange][google.spanner.v1.KeyRange] for more information about key range specifications.
- KeySet::getAll() — Method in class KeySet
- For convenience
allcan be set totrueto indicate that thisKeySetmatches all keys in the table or index. Note that any keys specified inkeysorrangesare only yielded once. - ListSessionsRequest::getDatabase() — Method in class ListSessionsRequest
- Required. The database in which to list sessions.
- ListSessionsRequest::getPageSize() — Method in class ListSessionsRequest
- Number of sessions to be returned in the response. If 0 or less, defaults to the server's maximum allowed page size.
- ListSessionsRequest::getPageToken() — Method in class ListSessionsRequest
- If non-empty,
page_tokenshould contain a [next_page_token][google.spanner.v1.ListSessionsResponse.next_page_token] from a previous [ListSessionsResponse][google.spanner.v1.ListSessionsResponse]. - ListSessionsRequest::getFilter() — Method in class ListSessionsRequest
- An expression for filtering the results of the request. Filter rules are
case insensitive. The fields eligible for filtering are:
*
labels.keywhere key is the name of a label Some examples of using filters are: *labels.env:*--> The session has the label "env". - ListSessionsResponse::getSessions() — Method in class ListSessionsResponse
- The list of requested sessions.
- ListSessionsResponse::getNextPageToken() — Method in class ListSessionsResponse
next_page_tokencan be sent in a subsequent [ListSessions][google.spanner.v1.Spanner.ListSessions] call to fetch more of the matching sessions.- Mutation::getInsert() — Method in class Mutation
- Insert new rows in a table. If any of the rows already exist,
the write or transaction fails with error
ALREADY_EXISTS. - Mutation::getUpdate() — Method in class Mutation
- Update existing rows in a table. If any of the rows does not
already exist, the transaction fails with error
NOT_FOUND. - Mutation::getInsertOrUpdate() — Method in class Mutation
- Like [insert][google.spanner.v1.Mutation.insert], except that if the row already exists, then its column values are overwritten with the ones provided. Any column values not explicitly written are preserved.
- Mutation::getReplace() — Method in class Mutation
- Like [insert][google.spanner.v1.Mutation.insert], except that if the row already exists, it is
deleted, and the column values provided are inserted
instead. Unlike [insert_or_update][google.spanner.v1.Mutation.insert_or_update], this means any values not
explicitly written become
NULL. - Mutation::getDelete() — Method in class Mutation
- Delete rows from a table. Succeeds whether or not the named rows were present.
- Mutation::getOperation() — Method in class Mutation
- Mutation_Delete::getTable() — Method in class Mutation_Delete
- Required. The table whose rows will be deleted.
- Mutation_Delete::getKeySet() — Method in class Mutation_Delete
- Required. The primary keys of the rows within [table][google.spanner.v1.Mutation.Delete.table] to delete.
- Mutation_Write::getTable() — Method in class Mutation_Write
- Required. The table whose rows will be written.
- Mutation_Write::getColumns() — Method in class Mutation_Write
- The names of the columns in [table][google.spanner.v1.Mutation.Write.table] to be written.
- Mutation_Write::getValues() — Method in class Mutation_Write
- The values to be written.
valuescan contain more than one list of values. If it does, then multiple rows are written, one for each entry invalues. Each list invaluesmust have exactly as many entries as there are entries in [columns][google.spanner.v1.Mutation.Write.columns] above. Sending multiple lists is equivalent to sending multipleMutations, each containing onevaluesentry and repeating [table][google.spanner.v1.Mutation.Write.table] and [columns][google.spanner.v1.Mutation.Write.columns]. Individual values in each list are encoded as described [here][google.spanner.v1.TypeCode]. - PartialResultSet::getMetadata() — Method in class PartialResultSet
- Metadata about the result set, such as row type information.
- PartialResultSet::getValues() — Method in class PartialResultSet
- A streamed result set consists of a stream of values, which might
be split into many
PartialResultSetmessages to accommodate large rows and/or large values. Every N complete values defines a row, where N is equal to the number of entries in [metadata.row_type.fields][google.spanner.v1.StructType.fields]. - PartialResultSet::getChunkedValue() — Method in class PartialResultSet
- If true, then the final value in [values][google.spanner.v1.PartialResultSet.values] is chunked, and must
be combined with more values from subsequent
PartialResultSets to obtain a complete field value. - PartialResultSet::getResumeToken() — Method in class PartialResultSet
- Streaming calls might be interrupted for a variety of reasons, such
as TCP connection loss. If this occurs, the stream of results can
be resumed by re-sending the original request and including
resume_token. Note that executing any other transaction in the same session invalidates the token. - PartialResultSet::getStats() — Method in class PartialResultSet
- Query plan and execution statistics for the query that produced this streaming result set. These can be requested by setting [ExecuteSqlRequest.query_mode][google.spanner.v1.ExecuteSqlRequest.query_mode] and are sent only once with the last response in the stream.
- Partition::getPartitionToken() — Method in class Partition
- This token can be passed to Read, StreamingRead, ExecuteSql, or ExecuteStreamingSql requests to restrict the results to those identified by this partition token.
- PartitionOptions::getPartitionSizeBytes() — Method in class PartitionOptions
- Note: This hint is currently ignored by PartitionQuery and PartitionRead requests.
- PartitionOptions::getMaxPartitions() — Method in class PartitionOptions
- Note: This hint is currently ignored by PartitionQuery and PartitionRead requests.
- PartitionQueryRequest::getSession() — Method in class PartitionQueryRequest
- Required. The session used to create the partitions.
- PartitionQueryRequest::getTransaction() — Method in class PartitionQueryRequest
- Read only snapshot transactions are supported, read/write and single use transactions are not.
- PartitionQueryRequest::getSql() — Method in class PartitionQueryRequest
- The query request to generate partitions for. The request will fail if the query is not root partitionable. The query plan of a root partitionable query has a single distributed union operator. A distributed union operator conceptually divides one or more tables into multiple splits, remotely evaluates a subquery independently on each split, and then unions all results.
- PartitionQueryRequest::getParams() — Method in class PartitionQueryRequest
- The SQL query string can contain parameter placeholders. A parameter
placeholder consists of
'@'followed by the parameter name. Parameter names consist of any combination of letters, numbers, and underscores. - PartitionQueryRequest::getParamTypes() — Method in class PartitionQueryRequest
- It is not always possible for Cloud Spanner to infer the right SQL type
from a JSON value. For example, values of type
BYTESand values of typeSTRINGboth appear in [params][google.spanner.v1.PartitionQueryRequest.params] as JSON strings. - PartitionQueryRequest::getPartitionOptions() — Method in class PartitionQueryRequest
- Additional options that affect how many partitions are created.
- PartitionReadRequest::getSession() — Method in class PartitionReadRequest
- Required. The session used to create the partitions.
- PartitionReadRequest::getTransaction() — Method in class PartitionReadRequest
- Read only snapshot transactions are supported, read/write and single use transactions are not.
- PartitionReadRequest::getTable() — Method in class PartitionReadRequest
- Required. The name of the table in the database to be read.
- PartitionReadRequest::getIndex() — Method in class PartitionReadRequest
- If non-empty, the name of an index on [table][google.spanner.v1.PartitionReadRequest.table]. This index is used instead of the table primary key when interpreting [key_set][google.spanner.v1.PartitionReadRequest.key_set] and sorting result rows. See [key_set][google.spanner.v1.PartitionReadRequest.key_set] for further information.
- PartitionReadRequest::getColumns() — Method in class PartitionReadRequest
- The columns of [table][google.spanner.v1.PartitionReadRequest.table] to be returned for each row matching this request.
- PartitionReadRequest::getKeySet() — Method in class PartitionReadRequest
- Required.
key_setidentifies the rows to be yielded.key_setnames the primary keys of the rows in [table][google.spanner.v1.PartitionReadRequest.table] to be yielded, unless [index][google.spanner.v1.PartitionReadRequest.index] is present. If [index][google.spanner.v1.PartitionReadRequest.index] is present, then [key_set][google.spanner.v1.PartitionReadRequest.key_set] instead names index keys in [index][google.spanner.v1.PartitionReadRequest.index]. - PartitionReadRequest::getPartitionOptions() — Method in class PartitionReadRequest
- Additional options that affect how many partitions are created.
- PartitionResponse::getPartitions() — Method in class PartitionResponse
- Partitions created by this request.
- PartitionResponse::getTransaction() — Method in class PartitionResponse
- Transaction created by this request.
- PlanNode::getIndex() — Method in class PlanNode
- The
PlanNode's index in [node list][google.spanner.v1.QueryPlan.plan_nodes]. - PlanNode::getKind() — Method in class PlanNode
- Used to determine the type of node. May be needed for visualizing different kinds of nodes differently. For example, If the node is a [SCALAR][google.spanner.v1.PlanNode.Kind.SCALAR] node, it will have a condensed representation which can be used to directly embed a description of the node in its parent.
- PlanNode::getDisplayName() — Method in class PlanNode
- The display name for the node.
- PlanNode::getChildLinks() — Method in class PlanNode
- List of child node
indexes and their relationship to this parent. - PlanNode::getShortRepresentation() — Method in class PlanNode
- Condensed representation for [SCALAR][google.spanner.v1.PlanNode.Kind.SCALAR] nodes.
- PlanNode::getMetadata() — Method in class PlanNode
- Attributes relevant to the node contained in a group of key-value pairs.
- PlanNode::getExecutionStats() — Method in class PlanNode
- The execution statistics associated with the node, contained in a group of key-value pairs. Only present if the plan was returned as a result of a profile query. For example, number of executions, number of rows/time per execution etc.
- PlanNode_ChildLink::getChildIndex() — Method in class PlanNode_ChildLink
- The node to which the link points.
- PlanNode_ChildLink::getType() — Method in class PlanNode_ChildLink
- The type of the link. For example, in Hash Joins this could be used to distinguish between the build child and the probe child, or in the case of the child being an output variable, to represent the tag associated with the output variable.
- PlanNode_ChildLink::getVariable() — Method in class PlanNode_ChildLink
- Only present if the child node is [SCALAR][google.spanner.v1.PlanNode.Kind.SCALAR] and corresponds to an output variable of the parent node. The field carries the name of the output variable.
- PlanNode_ShortRepresentation::getDescription() — Method in class PlanNode_ShortRepresentation
- A string representation of the expression subtree rooted at this node.
- PlanNode_ShortRepresentation::getSubqueries() — Method in class PlanNode_ShortRepresentation
- A mapping of (subquery variable name) -> (subquery node id) for cases
where the
descriptionstring of this node references aSCALARsubquery contained in the expression subtree rooted at this node. The referencedSCALARsubquery may not necessarily be a direct child of this node. - QueryPlan::getPlanNodes() — Method in class QueryPlan
- The nodes in the query plan. Plan nodes are returned in pre-order starting
with the plan root. Each [PlanNode][google.spanner.v1.PlanNode]'s
idcorresponds to its index inplan_nodes. - ReadRequest::getSession() — Method in class ReadRequest
- Required. The session in which the read should be performed.
- ReadRequest::getTransaction() — Method in class ReadRequest
- The transaction to use. If none is provided, the default is a temporary read-only transaction with strong concurrency.
- ReadRequest::getTable() — Method in class ReadRequest
- Required. The name of the table in the database to be read.
- ReadRequest::getIndex() — Method in class ReadRequest
- If non-empty, the name of an index on [table][google.spanner.v1.ReadRequest.table]. This index is used instead of the table primary key when interpreting [key_set][google.spanner.v1.ReadRequest.key_set] and sorting result rows. See [key_set][google.spanner.v1.ReadRequest.key_set] for further information.
- ReadRequest::getColumns() — Method in class ReadRequest
- The columns of [table][google.spanner.v1.ReadRequest.table] to be returned for each row matching this request.
- ReadRequest::getKeySet() — Method in class ReadRequest
- Required.
key_setidentifies the rows to be yielded.key_setnames the primary keys of the rows in [table][google.spanner.v1.ReadRequest.table] to be yielded, unless [index][google.spanner.v1.ReadRequest.index] is present. If [index][google.spanner.v1.ReadRequest.index] is present, then [key_set][google.spanner.v1.ReadRequest.key_set] instead names index keys in [index][google.spanner.v1.ReadRequest.index]. - ReadRequest::getLimit() — Method in class ReadRequest
- If greater than zero, only the first
limitrows are yielded. Iflimitis zero, the default is no limit. A limit cannot be specified ifpartition_tokenis set. - ReadRequest::getResumeToken() — Method in class ReadRequest
- If this request is resuming a previously interrupted read,
resume_tokenshould be copied from the last [PartialResultSet][google.spanner.v1.PartialResultSet] yielded before the interruption. Doing this enables the new read to resume where the last read left off. The rest of the request parameters must exactly match the request that yielded this token. - ReadRequest::getPartitionToken() — Method in class ReadRequest
- If present, results will be restricted to the specified partition previously created using PartitionRead(). There must be an exact match for the values of fields common to this message and the PartitionReadRequest message used to create this partition_token.
- ResultSet::getMetadata() — Method in class ResultSet
- Metadata about the result set, such as row type information.
- ResultSet::getRows() — Method in class ResultSet
- Each element in
rowsis a row whose format is defined by [metadata.row_type][google.spanner.v1.ResultSetMetadata.row_type]. The ith element in each row matches the ith field in [metadata.row_type][google.spanner.v1.ResultSetMetadata.row_type]. Elements are encoded based on type as described [here][google.spanner.v1.TypeCode]. - ResultSet::getStats() — Method in class ResultSet
- Query plan and execution statistics for the query that produced this result set. These can be requested by setting [ExecuteSqlRequest.query_mode][google.spanner.v1.ExecuteSqlRequest.query_mode].
- ResultSetMetadata::getRowType() — Method in class ResultSetMetadata
- Indicates the field names and types for the rows in the result
set. For example, a SQL query like
"SELECT UserId, UserName FROM Users"could return arow_typevalue like: "fields": [ { "name": "UserId", "type": { "code": "INT64" } }, { "name": "UserName", "type": { "code": "STRING" } }, ] - ResultSetMetadata::getTransaction() — Method in class ResultSetMetadata
- If the read or SQL query began a transaction as a side-effect, the information about the new transaction is yielded here.
- ResultSetStats::getQueryPlan() — Method in class ResultSetStats
- [QueryPlan][google.spanner.v1.QueryPlan] for the query associated with this result.
- ResultSetStats::getQueryStats() — Method in class ResultSetStats
- Aggregated statistics from the execution of the query. Only present when the query is profiled. For example, a query could return the statistics as follows: { "rows_returned": "3", "elapsed_time": "1.22 secs", "cpu_time": "1.19 secs" }
- RollbackRequest::getSession() — Method in class RollbackRequest
- Required. The session in which the transaction to roll back is running.
- RollbackRequest::getTransactionId() — Method in class RollbackRequest
- Required. The transaction to roll back.
- Session::getName() — Method in class Session
- The name of the session. This is always system-assigned; values provided when creating a session are ignored.
- Session::getLabels() — Method in class Session
- The labels for the session.
- Session::getCreateTime() — Method in class Session
- Output only. The timestamp when the session is created.
- Session::getApproximateLastUseTime() — Method in class Session
- Output only. The approximate timestamp when the session is last used. It is typically earlier than the actual last use time.
- SpannerGrpcClient::GetSession() — Method in class SpannerGrpcClient
- Gets a session. Returns
NOT_FOUNDif the session does not exist. - StructType::getFields() — Method in class StructType
- The list of fields that make up this struct. Order is
significant, because values of this struct type are represented as
lists, where the order of field values matches the order of
fields in the [StructType][google.spanner.v1.StructType]. In turn, the order of fields
matches the order of columns in a read request, or the order of
fields in the
SELECTclause of a query. - StructType_Field::getName() — Method in class StructType_Field
- The name of the field. For reads, this is the column name. For
SQL queries, it is the column alias (e.g.,
"Word"in the query"SELECT 'hello' AS Word"), or the column name (e.g.,"ColName"in the query"SELECT ColName FROM Table"). Some columns might have an empty name (e.g., !"SELECT UPPER(ColName)"`). Note that a query result can contain multiple fields with the same name. - StructType_Field::getType() — Method in class StructType_Field
- The type of the field.
- Transaction::getId() — Method in class Transaction
idmay be used to identify the transaction in subsequent [Read][google.spanner.v1.Spanner.Read], [ExecuteSql][google.spanner.v1.Spanner.ExecuteSql], [Commit][google.spanner.v1.Spanner.Commit], or [Rollback][google.spanner.v1.Spanner.Rollback] calls.- Transaction::getReadTimestamp() — Method in class Transaction
- For snapshot read-only transactions, the read timestamp chosen for the transaction. Not returned by default: see [TransactionOptions.ReadOnly.return_read_timestamp][google.spanner.v1.TransactionOptions.ReadOnly.return_read_timestamp].
- TransactionOptions::getReadWrite() — Method in class TransactionOptions
- Transaction may write.
- TransactionOptions::getReadOnly() — Method in class TransactionOptions
- Transaction will not write.
- TransactionOptions::getMode() — Method in class TransactionOptions
- TransactionOptions_ReadOnly::getStrong() — Method in class TransactionOptions_ReadOnly
- Read at a timestamp where all previously committed transactions are visible.
- TransactionOptions_ReadOnly::getMinReadTimestamp() — Method in class TransactionOptions_ReadOnly
- Executes all reads at a timestamp >=
min_read_timestamp. - TransactionOptions_ReadOnly::getMaxStaleness() — Method in class TransactionOptions_ReadOnly
- Read data at a timestamp >=
NOW - max_stalenessseconds. Guarantees that all writes that have committed more than the specified number of seconds ago are visible. Because Cloud Spanner chooses the exact timestamp, this mode works even if the client's local clock is substantially skewed from Cloud Spanner commit timestamps. - TransactionOptions_ReadOnly::getReadTimestamp() — Method in class TransactionOptions_ReadOnly
- Executes all reads at the given timestamp. Unlike other modes, reads at a specific timestamp are repeatable; the same read at the same timestamp always returns the same data. If the timestamp is in the future, the read will block until the specified timestamp, modulo the read's deadline.
- TransactionOptions_ReadOnly::getExactStaleness() — Method in class TransactionOptions_ReadOnly
- Executes all reads at a timestamp that is
exact_stalenessold. The timestamp is chosen soon after the read is started. - TransactionOptions_ReadOnly::getReturnReadTimestamp() — Method in class TransactionOptions_ReadOnly
- If true, the Cloud Spanner-selected read timestamp is included in the [Transaction][google.spanner.v1.Transaction] message that describes the transaction.
- TransactionOptions_ReadOnly::getTimestampBound() — Method in class TransactionOptions_ReadOnly
- TransactionSelector::getSingleUse() — Method in class TransactionSelector
- Execute the read or SQL query in a temporary transaction.
- TransactionSelector::getId() — Method in class TransactionSelector
- Execute the read or SQL query in a previously-started transaction.
- TransactionSelector::getBegin() — Method in class TransactionSelector
- Begin a new transaction and execute this read or SQL query in it. The transaction ID of the new transaction is returned in [ResultSetMetadata.transaction][google.spanner.v1.ResultSetMetadata.transaction], which is a [Transaction][google.spanner.v1.Transaction].
- TransactionSelector::getSelector() — Method in class TransactionSelector
- Type::getCode() — Method in class Type
- Required. The [TypeCode][google.spanner.v1.TypeCode] for this type.
- Type::getArrayElementType() — Method in class Type
- If [code][google.spanner.v1.Type.code] == [ARRAY][google.spanner.v1.TypeCode.ARRAY], then
array_element_typeis the type of the array elements. - Type::getStructType() — Method in class Type
- If [code][google.spanner.v1.Type.code] == [STRUCT][google.spanner.v1.TypeCode.STRUCT], then
struct_typeprovides type information for the struct's fields. - LongRunningRecognizeMetadata::getProgressPercent() — Method in class LongRunningRecognizeMetadata
- Approximate percentage of audio processed thus far. Guaranteed to be 100 when the audio is fully processed and the results are available.
- LongRunningRecognizeMetadata::getStartTime() — Method in class LongRunningRecognizeMetadata
- Time when the request was received.
- LongRunningRecognizeMetadata::getLastUpdateTime() — Method in class LongRunningRecognizeMetadata
- Time of the most recent processing update.
- LongRunningRecognizeRequest::getConfig() — Method in class LongRunningRecognizeRequest
- Required Provides information to the recognizer that specifies how to process the request.
- LongRunningRecognizeRequest::getAudio() — Method in class LongRunningRecognizeRequest
- Required The audio data to be recognized.
- LongRunningRecognizeResponse::getResults() — Method in class LongRunningRecognizeResponse
- Output-only Sequential list of transcription results corresponding to sequential portions of audio.
- RecognitionAudio::getContent() — Method in class RecognitionAudio
- The audio data bytes encoded as specified in
RecognitionConfig. Note: as with all bytes fields, protobuffers use a pure binary representation, whereas JSON representations use base64. - RecognitionAudio::getUri() — Method in class RecognitionAudio
- URI that points to a file that contains audio data bytes as specified in
RecognitionConfig. Currently, only Google Cloud Storage URIs are supported, which must be specified in the following format:gs://bucket_name/object_name(other URI formats return [google.rpc.Code.INVALID_ARGUMENT][google.rpc.Code.INVALID_ARGUMENT]). For more information, see Request URIs. - RecognitionAudio::getAudioSource() — Method in class RecognitionAudio
- RecognitionConfig::getEncoding() — Method in class RecognitionConfig
- Required Encoding of audio data sent in all
RecognitionAudiomessages. - RecognitionConfig::getSampleRateHertz() — Method in class RecognitionConfig
- Required Sample rate in Hertz of the audio data sent in all
RecognitionAudiomessages. Valid values are: 8000-48000. - RecognitionConfig::getLanguageCode() — Method in class RecognitionConfig
- Required The language of the supplied audio as a BCP-47 language tag.
- RecognitionConfig::getMaxAlternatives() — Method in class RecognitionConfig
- Optional Maximum number of recognition hypotheses to be returned.
- RecognitionConfig::getProfanityFilter() — Method in class RecognitionConfig
- Optional If set to
true, the server will attempt to filter out profanities, replacing all but the initial character in each filtered word with asterisks, e.g. "f***". If set tofalseor omitted, profanities won't be filtered out. - RecognitionConfig::getSpeechContexts() — Method in class RecognitionConfig
- Optional A means to provide context to assist the speech recognition.
- RecognitionConfig::getEnableWordTimeOffsets() — Method in class RecognitionConfig
- Optional If
true, the top result includes a list of words and the start and end time offsets (timestamps) for those words. Iffalse, no word-level time offset information is returned. The default isfalse. - RecognizeRequest::getConfig() — Method in class RecognizeRequest
- Required Provides information to the recognizer that specifies how to process the request.
- RecognizeRequest::getAudio() — Method in class RecognizeRequest
- Required The audio data to be recognized.
- RecognizeResponse::getResults() — Method in class RecognizeResponse
- Output-only Sequential list of transcription results corresponding to sequential portions of audio.
- SpeechContext::getPhrases() — Method in class SpeechContext
- Optional A list of strings containing words and phrases "hints" so that the speech recognition is more likely to recognize them. This can be used to improve the accuracy for specific words and phrases, for example, if specific commands are typically spoken by the user. This can also be used to add additional words to the vocabulary of the recognizer. See usage limits.
- SpeechRecognitionAlternative::getTranscript() — Method in class SpeechRecognitionAlternative
- Output-only Transcript text representing the words that the user spoke.
- SpeechRecognitionAlternative::getConfidence() — Method in class SpeechRecognitionAlternative
- Output-only The confidence estimate between 0.0 and 1.0. A higher number
indicates an estimated greater likelihood that the recognized words are
correct. This field is typically provided only for the top hypothesis, and
only for
is_final=trueresults. Clients should not rely on theconfidencefield as it is not guaranteed to be accurate or consistent. - SpeechRecognitionAlternative::getWords() — Method in class SpeechRecognitionAlternative
- Output-only A list of word-specific information for each recognized word.
- SpeechRecognitionResult::getAlternatives() — Method in class SpeechRecognitionResult
- Output-only May contain one or more recognition hypotheses (up to the
maximum specified in
max_alternatives). - StreamingRecognitionConfig::getConfig() — Method in class StreamingRecognitionConfig
- Required Provides information to the recognizer that specifies how to process the request.
- StreamingRecognitionConfig::getSingleUtterance() — Method in class StreamingRecognitionConfig
- Optional If
falseor omitted, the recognizer will perform continuous recognition (continuing to wait for and process audio even if the user pauses speaking) until the client closes the input stream (gRPC API) or until the maximum time limit has been reached. May return multipleStreamingRecognitionResults with theis_finalflag set totrue. - StreamingRecognitionConfig::getInterimResults() — Method in class StreamingRecognitionConfig
- Optional If
true, interim results (tentative hypotheses) may be returned as they become available (these interim results are indicated with theis_final=falseflag). - StreamingRecognitionResult::getAlternatives() — Method in class StreamingRecognitionResult
- Output-only May contain one or more recognition hypotheses (up to the
maximum specified in
max_alternatives). - StreamingRecognitionResult::getIsFinal() — Method in class StreamingRecognitionResult
- Output-only If
false, thisStreamingRecognitionResultrepresents an interim result that may change. Iftrue, this is the final time the speech service will return this particularStreamingRecognitionResult, the recognizer will not return any further hypotheses for this portion of the transcript and corresponding audio. - StreamingRecognitionResult::getStability() — Method in class StreamingRecognitionResult
- Output-only An estimate of the likelihood that the recognizer will not change its guess about this interim result. Values range from 0.0 (completely unstable) to 1.0 (completely stable).
- StreamingRecognizeRequest::getStreamingConfig() — Method in class StreamingRecognizeRequest
- Provides information to the recognizer that specifies how to process the
request. The first
StreamingRecognizeRequestmessage must contain astreaming_configmessage. - StreamingRecognizeRequest::getAudioContent() — Method in class StreamingRecognizeRequest
- The audio data to be recognized. Sequential chunks of audio data are sent
in sequential
StreamingRecognizeRequestmessages. The firstStreamingRecognizeRequestmessage must not containaudio_contentdata and all subsequentStreamingRecognizeRequestmessages must containaudio_contentdata. The audio bytes must be encoded as specified inRecognitionConfig. Note: as with all bytes fields, protobuffers use a pure binary representation (not base64). See audio limits. - StreamingRecognizeRequest::getStreamingRequest() — Method in class StreamingRecognizeRequest
- StreamingRecognizeResponse::getError() — Method in class StreamingRecognizeResponse
- Output-only If set, returns a [google.rpc.Status][google.rpc.Status] message that specifies the error for the operation.
- StreamingRecognizeResponse::getResults() — Method in class StreamingRecognizeResponse
- Output-only This repeated list contains zero or more results that correspond to consecutive portions of the audio currently being processed.
- StreamingRecognizeResponse::getSpeechEventType() — Method in class StreamingRecognizeResponse
- Output-only Indicates the type of speech event.
- WordInfo::getStartTime() — Method in class WordInfo
- Output-only Time offset relative to the beginning of the audio, and corresponding to the start of the spoken word.
- WordInfo::getEndTime() — Method in class WordInfo
- Output-only Time offset relative to the beginning of the audio, and corresponding to the end of the spoken word.
- WordInfo::getWord() — Method in class WordInfo
- Output-only The word corresponding to this set of information.
- AsyncRecognizeMetadata::getProgressPercent() — Method in class AsyncRecognizeMetadata
- Approximate percentage of audio processed thus far. Guaranteed to be 100 when the audio is fully processed and the results are available.
- AsyncRecognizeMetadata::getStartTime() — Method in class AsyncRecognizeMetadata
- Time when the request was received.
- AsyncRecognizeMetadata::getLastUpdateTime() — Method in class AsyncRecognizeMetadata
- Time of the most recent processing update.
- AsyncRecognizeRequest::getConfig() — Method in class AsyncRecognizeRequest
- Required Provides information to the recognizer that specifies how to process the request.
- AsyncRecognizeRequest::getAudio() — Method in class AsyncRecognizeRequest
- Required The audio data to be recognized.
- AsyncRecognizeResponse::getResults() — Method in class AsyncRecognizeResponse
- Output-only Sequential list of transcription results corresponding to sequential portions of audio.
- RecognitionAudio::getContent() — Method in class RecognitionAudio
- The audio data bytes encoded as specified in
RecognitionConfig. Note: as with all bytes fields, protobuffers use a pure binary representation, whereas JSON representations use base64. - RecognitionAudio::getUri() — Method in class RecognitionAudio
- URI that points to a file that contains audio data bytes as specified in
RecognitionConfig. Currently, only Google Cloud Storage URIs are supported, which must be specified in the following format:gs://bucket_name/object_name(other URI formats return [google.rpc.Code.INVALID_ARGUMENT][google.rpc.Code.INVALID_ARGUMENT]). For more information, see Request URIs. - RecognitionAudio::getAudioSource() — Method in class RecognitionAudio
- RecognitionConfig::getEncoding() — Method in class RecognitionConfig
- Required Encoding of audio data sent in all
RecognitionAudiomessages. - RecognitionConfig::getSampleRate() — Method in class RecognitionConfig
- Required Sample rate in Hertz of the audio data sent in all
RecognitionAudiomessages. Valid values are: 8000-48000. - RecognitionConfig::getLanguageCode() — Method in class RecognitionConfig
- Optional The language of the supplied audio as a BCP-47 language tag.
- RecognitionConfig::getMaxAlternatives() — Method in class RecognitionConfig
- Optional Maximum number of recognition hypotheses to be returned.
- RecognitionConfig::getProfanityFilter() — Method in class RecognitionConfig
- Optional If set to
true, the server will attempt to filter out profanities, replacing all but the initial character in each filtered word with asterisks, e.g. "f***". If set tofalseor omitted, profanities won't be filtered out. - RecognitionConfig::getSpeechContext() — Method in class RecognitionConfig
- Optional A means to provide context to assist the speech recognition.
- SpeechContext::getPhrases() — Method in class SpeechContext
- Optional A list of strings containing words and phrases "hints" so that the speech recognition is more likely to recognize them. This can be used to improve the accuracy for specific words and phrases, for example, if specific commands are typically spoken by the user. This can also be used to add additional words to the vocabulary of the recognizer. See usage limits.
- SpeechRecognitionAlternative::getTranscript() — Method in class SpeechRecognitionAlternative
- Output-only Transcript text representing the words that the user spoke.
- SpeechRecognitionAlternative::getConfidence() — Method in class SpeechRecognitionAlternative
- Output-only The confidence estimate between 0.0 and 1.0. A higher number
indicates an estimated greater likelihood that the recognized words are
correct. This field is typically provided only for the top hypothesis, and
only for
is_final=trueresults. Clients should not rely on theconfidencefield as it is not guaranteed to be accurate, or even set, in any of the results. - SpeechRecognitionResult::getAlternatives() — Method in class SpeechRecognitionResult
- Output-only May contain one or more recognition hypotheses (up to the
maximum specified in
max_alternatives). - StreamingRecognitionConfig::getConfig() — Method in class StreamingRecognitionConfig
- Required Provides information to the recognizer that specifies how to process the request.
- StreamingRecognitionConfig::getSingleUtterance() — Method in class StreamingRecognitionConfig
- Optional If
falseor omitted, the recognizer will perform continuous recognition (continuing to wait for and process audio even if the user pauses speaking) until the client closes the input stream (gRPC API) or until the maximum time limit has been reached. May return multipleStreamingRecognitionResults with theis_finalflag set totrue. - StreamingRecognitionConfig::getInterimResults() — Method in class StreamingRecognitionConfig
- Optional If
true, interim results (tentative hypotheses) may be returned as they become available (these interim results are indicated with theis_final=falseflag). - StreamingRecognitionResult::getAlternatives() — Method in class StreamingRecognitionResult
- Output-only May contain one or more recognition hypotheses (up to the
maximum specified in
max_alternatives). - StreamingRecognitionResult::getIsFinal() — Method in class StreamingRecognitionResult
- Output-only If
false, thisStreamingRecognitionResultrepresents an interim result that may change. Iftrue, this is the final time the speech service will return this particularStreamingRecognitionResult, the recognizer will not return any further hypotheses for this portion of the transcript and corresponding audio. - StreamingRecognitionResult::getStability() — Method in class StreamingRecognitionResult
- Output-only An estimate of the likelihood that the recognizer will not change its guess about this interim result. Values range from 0.0 (completely unstable) to 1.0 (completely stable).
- StreamingRecognizeRequest::getStreamingConfig() — Method in class StreamingRecognizeRequest
- Provides information to the recognizer that specifies how to process the
request. The first
StreamingRecognizeRequestmessage must contain astreaming_configmessage. - StreamingRecognizeRequest::getAudioContent() — Method in class StreamingRecognizeRequest
- The audio data to be recognized. Sequential chunks of audio data are sent
in sequential
StreamingRecognizeRequestmessages. The firstStreamingRecognizeRequestmessage must not containaudio_contentdata and all subsequentStreamingRecognizeRequestmessages must containaudio_contentdata. The audio bytes must be encoded as specified inRecognitionConfig. Note: as with all bytes fields, protobuffers use a pure binary representation (not base64). See audio limits. - StreamingRecognizeRequest::getStreamingRequest() — Method in class StreamingRecognizeRequest
- StreamingRecognizeResponse::getError() — Method in class StreamingRecognizeResponse
- Output-only If set, returns a [google.rpc.Status][google.rpc.Status] message that specifies the error for the operation.
- StreamingRecognizeResponse::getResults() — Method in class StreamingRecognizeResponse
- Output-only This repeated list contains zero or more results that correspond to consecutive portions of the audio currently being processed.
- StreamingRecognizeResponse::getResultIndex() — Method in class StreamingRecognizeResponse
- Output-only Indicates the lowest index in the
resultsarray that has changed. The repeatedStreamingRecognitionResultresults overwrite past results at this index and higher. - StreamingRecognizeResponse::getEndpointerType() — Method in class StreamingRecognizeResponse
- Output-only Indicates the type of endpointer event.
- SyncRecognizeRequest::getConfig() — Method in class SyncRecognizeRequest
- Required Provides information to the recognizer that specifies how to process the request.
- SyncRecognizeRequest::getAudio() — Method in class SyncRecognizeRequest
- Required The audio data to be recognized.
- SyncRecognizeResponse::getResults() — Method in class SyncRecognizeResponse
- Output-only Sequential list of transcription results corresponding to sequential portions of audio.
- LongRunningRecognizeMetadata::getProgressPercent() — Method in class LongRunningRecognizeMetadata
- Approximate percentage of audio processed thus far. Guaranteed to be 100 when the audio is fully processed and the results are available.
- LongRunningRecognizeMetadata::getStartTime() — Method in class LongRunningRecognizeMetadata
- Time when the request was received.
- LongRunningRecognizeMetadata::getLastUpdateTime() — Method in class LongRunningRecognizeMetadata
- Time of the most recent processing update.
- LongRunningRecognizeRequest::getConfig() — Method in class LongRunningRecognizeRequest
- Required Provides information to the recognizer that specifies how to process the request.
- LongRunningRecognizeRequest::getAudio() — Method in class LongRunningRecognizeRequest
- Required The audio data to be recognized.
- LongRunningRecognizeResponse::getResults() — Method in class LongRunningRecognizeResponse
- Output only. Sequential list of transcription results corresponding to sequential portions of audio.
- RecognitionAudio::getContent() — Method in class RecognitionAudio
- The audio data bytes encoded as specified in
RecognitionConfig. Note: as with all bytes fields, protobuffers use a pure binary representation, whereas JSON representations use base64. - RecognitionAudio::getUri() — Method in class RecognitionAudio
- URI that points to a file that contains audio data bytes as specified in
RecognitionConfig. Currently, only Google Cloud Storage URIs are supported, which must be specified in the following format:gs://bucket_name/object_name(other URI formats return [google.rpc.Code.INVALID_ARGUMENT][google.rpc.Code.INVALID_ARGUMENT]). For more information, see Request URIs. - RecognitionAudio::getAudioSource() — Method in class RecognitionAudio
- RecognitionConfig::getEncoding() — Method in class RecognitionConfig
- Encoding of audio data sent in all
RecognitionAudiomessages. - RecognitionConfig::getSampleRateHertz() — Method in class RecognitionConfig
- Sample rate in Hertz of the audio data sent in all
RecognitionAudiomessages. Valid values are: 8000-48000. - RecognitionConfig::getAudioChannelCount() — Method in class RecognitionConfig
- Optional The number of channels in the input audio data.
- RecognitionConfig::getEnableSeparateRecognitionPerChannel() — Method in class RecognitionConfig
- This needs to be set to ‘true’ explicitly and audio_channel_count > 1 to get each channel recognized separately. The recognition result will contain a channel_tag field to state which channel that result belongs to.
- RecognitionConfig::getLanguageCode() — Method in class RecognitionConfig
- Required The language of the supplied audio as a BCP-47 language tag.
- RecognitionConfig::getAlternativeLanguageCodes() — Method in class RecognitionConfig
- Optional A list of up to 3 additional BCP-47 language tags, listing possible alternative languages of the supplied audio.
- RecognitionConfig::getMaxAlternatives() — Method in class RecognitionConfig
- Optional Maximum number of recognition hypotheses to be returned.
- RecognitionConfig::getProfanityFilter() — Method in class RecognitionConfig
- Optional If set to
true, the server will attempt to filter out profanities, replacing all but the initial character in each filtered word with asterisks, e.g. "f***". If set tofalseor omitted, profanities won't be filtered out. - RecognitionConfig::getSpeechContexts() — Method in class RecognitionConfig
- Optional A means to provide context to assist the speech recognition.
- RecognitionConfig::getEnableWordTimeOffsets() — Method in class RecognitionConfig
- Optional If
true, the top result includes a list of words and the start and end time offsets (timestamps) for those words. Iffalse, no word-level time offset information is returned. The default isfalse. - RecognitionConfig::getEnableWordConfidence() — Method in class RecognitionConfig
- Optional If
true, the top result includes a list of words and the confidence for those words. Iffalse, no word-level confidence information is returned. The default isfalse. - RecognitionConfig::getEnableAutomaticPunctuation() — Method in class RecognitionConfig
- Optional If 'true', adds punctuation to recognition result hypotheses.
- RecognitionConfig::getEnableSpeakerDiarization() — Method in class RecognitionConfig
- Optional If 'true', enables speaker detection for each recognized word in the top alternative of the recognition result using a speaker_tag provided in the WordInfo.
- RecognitionConfig::getDiarizationSpeakerCount() — Method in class RecognitionConfig
- Optional If set, specifies the estimated number of speakers in the conversation.
- RecognitionConfig::getMetadata() — Method in class RecognitionConfig
- Optional Metadata regarding this request.
- RecognitionConfig::getModel() — Method in class RecognitionConfig
- Optional Which model to select for the given request. Select the model best suited to your domain to get best results. If a model is not explicitly specified, then we auto-select a model based on the parameters in the RecognitionConfig.
- RecognitionConfig::getUseEnhanced() — Method in class RecognitionConfig
- Optional Set to true to use an enhanced model for speech recognition.
- RecognitionMetadata::getInteractionType() — Method in class RecognitionMetadata
- The use case most closely describing the audio content to be recognized.
- RecognitionMetadata::getIndustryNaicsCodeOfAudio() — Method in class RecognitionMetadata
- The industry vertical to which this speech recognition request most closely applies. This is most indicative of the topics contained in the audio. Use the 6-digit NAICS code to identify the industry vertical - see https://www.naics.com/search/.
- RecognitionMetadata::getMicrophoneDistance() — Method in class RecognitionMetadata
- The audio type that most closely describes the audio being recognized.
- RecognitionMetadata::getOriginalMediaType() — Method in class RecognitionMetadata
- The original media the speech was recorded on.
- RecognitionMetadata::getRecordingDeviceType() — Method in class RecognitionMetadata
- The type of device the speech was recorded with.
- RecognitionMetadata::getRecordingDeviceName() — Method in class RecognitionMetadata
- The device used to make the recording. Examples 'Nexus 5X' or 'Polycom SoundStation IP 6000' or 'POTS' or 'VoIP' or 'Cardioid Microphone'.
- RecognitionMetadata::getOriginalMimeType() — Method in class RecognitionMetadata
- Mime type of the original audio file. For example
audio/m4a,audio/x-alaw-basic,audio/mp3,audio/3gpp. - RecognitionMetadata::getObfuscatedId() — Method in class RecognitionMetadata
- Obfuscated (privacy-protected) ID of the user, to identify number of unique users using the service.
- RecognitionMetadata::getAudioTopic() — Method in class RecognitionMetadata
- Description of the content. Eg. "Recordings of federal supreme court hearings from 2012".
- RecognizeRequest::getConfig() — Method in class RecognizeRequest
- Required Provides information to the recognizer that specifies how to process the request.
- RecognizeRequest::getAudio() — Method in class RecognizeRequest
- Required The audio data to be recognized.
- RecognizeResponse::getResults() — Method in class RecognizeResponse
- Output only. Sequential list of transcription results corresponding to sequential portions of audio.
- SpeechContext::getPhrases() — Method in class SpeechContext
- Optional A list of strings containing words and phrases "hints" so that the speech recognition is more likely to recognize them. This can be used to improve the accuracy for specific words and phrases, for example, if specific commands are typically spoken by the user. This can also be used to add additional words to the vocabulary of the recognizer. See usage limits.
- SpeechRecognitionAlternative::getTranscript() — Method in class SpeechRecognitionAlternative
- Output only. Transcript text representing the words that the user spoke.
- SpeechRecognitionAlternative::getConfidence() — Method in class SpeechRecognitionAlternative
- Output only. The confidence estimate between 0.0 and 1.0. A higher number
indicates an estimated greater likelihood that the recognized words are
correct. This field is set only for the top alternative of a non-streaming
result or, of a streaming result where
is_final=true. - SpeechRecognitionAlternative::getWords() — Method in class SpeechRecognitionAlternative
- Output only. A list of word-specific information for each recognized word.
- SpeechRecognitionResult::getAlternatives() — Method in class SpeechRecognitionResult
- Output only. May contain one or more recognition hypotheses (up to the
maximum specified in
max_alternatives). - SpeechRecognitionResult::getChannelTag() — Method in class SpeechRecognitionResult
- For multi-channel audio, this is the channel number corresponding to the recognized result for the audio from that channel.
- SpeechRecognitionResult::getLanguageCode() — Method in class SpeechRecognitionResult
- Output only. The BCP-47 language tag of the language in this result. This language code was detected to have the most likelihood of being spoken in the audio.
- StreamingRecognitionConfig::getConfig() — Method in class StreamingRecognitionConfig
- Required Provides information to the recognizer that specifies how to process the request.
- StreamingRecognitionConfig::getSingleUtterance() — Method in class StreamingRecognitionConfig
- Optional If
falseor omitted, the recognizer will perform continuous recognition (continuing to wait for and process audio even if the user pauses speaking) until the client closes the input stream (gRPC API) or until the maximum time limit has been reached. May return multipleStreamingRecognitionResults with theis_finalflag set totrue. - StreamingRecognitionConfig::getInterimResults() — Method in class StreamingRecognitionConfig
- Optional If
true, interim results (tentative hypotheses) may be returned as they become available (these interim results are indicated with theis_final=falseflag). - StreamingRecognitionResult::getAlternatives() — Method in class StreamingRecognitionResult
- Output only. May contain one or more recognition hypotheses (up to the
maximum specified in
max_alternatives). - StreamingRecognitionResult::getIsFinal() — Method in class StreamingRecognitionResult
- Output only. If
false, thisStreamingRecognitionResultrepresents an interim result that may change. Iftrue, this is the final time the speech service will return this particularStreamingRecognitionResult, the recognizer will not return any further hypotheses for this portion of the transcript and corresponding audio. - StreamingRecognitionResult::getStability() — Method in class StreamingRecognitionResult
- Output only. An estimate of the likelihood that the recognizer will not change its guess about this interim result. Values range from 0.0 (completely unstable) to 1.0 (completely stable).
- StreamingRecognitionResult::getChannelTag() — Method in class StreamingRecognitionResult
- For multi-channel audio, this is the channel number corresponding to the recognized result for the audio from that channel.
- StreamingRecognitionResult::getLanguageCode() — Method in class StreamingRecognitionResult
- Output only. The BCP-47 language tag of the language in this result. This language code was detected to have the most likelihood of being spoken in the audio.
- StreamingRecognizeRequest::getStreamingConfig() — Method in class StreamingRecognizeRequest
- Provides information to the recognizer that specifies how to process the
request. The first
StreamingRecognizeRequestmessage must contain astreaming_configmessage. - StreamingRecognizeRequest::getAudioContent() — Method in class StreamingRecognizeRequest
- The audio data to be recognized. Sequential chunks of audio data are sent
in sequential
StreamingRecognizeRequestmessages. The firstStreamingRecognizeRequestmessage must not containaudio_contentdata and all subsequentStreamingRecognizeRequestmessages must containaudio_contentdata. The audio bytes must be encoded as specified inRecognitionConfig. Note: as with all bytes fields, protobuffers use a pure binary representation (not base64). See audio limits. - StreamingRecognizeRequest::getStreamingRequest() — Method in class StreamingRecognizeRequest
- StreamingRecognizeResponse::getError() — Method in class StreamingRecognizeResponse
- Output only. If set, returns a [google.rpc.Status][google.rpc.Status] message that specifies the error for the operation.
- StreamingRecognizeResponse::getResults() — Method in class StreamingRecognizeResponse
- Output only. This repeated list contains zero or more results that correspond to consecutive portions of the audio currently being processed.
- StreamingRecognizeResponse::getSpeechEventType() — Method in class StreamingRecognizeResponse
- Output only. Indicates the type of speech event.
- WordInfo::getStartTime() — Method in class WordInfo
- Output only. Time offset relative to the beginning of the audio, and corresponding to the start of the spoken word.
- WordInfo::getEndTime() — Method in class WordInfo
- Output only. Time offset relative to the beginning of the audio, and corresponding to the end of the spoken word.
- WordInfo::getWord() — Method in class WordInfo
- Output only. The word corresponding to this set of information.
- WordInfo::getConfidence() — Method in class WordInfo
- Output only. The confidence estimate between 0.0 and 1.0. A higher number
indicates an estimated greater likelihood that the recognized words are
correct. This field is set only for the top alternative of a non-streaming
result or, of a streaming result where
is_final=true. - WordInfo::getSpeakerTag() — Method in class WordInfo
- Output only. A distinct integer value is assigned for every speaker within the audio. This field specifies which one of those speakers was detected to have spoken this word. Value ranges from '1' to diarization_speaker_count.
- AcknowledgeTaskRequest::getName() — Method in class AcknowledgeTaskRequest
- Required.
- AcknowledgeTaskRequest::getScheduleTime() — Method in class AcknowledgeTaskRequest
- Required.
- AppEngineHttpRequest::getHttpMethod() — Method in class AppEngineHttpRequest
- The HTTP method to use for the request. The default is POST.
- AppEngineHttpRequest::getAppEngineRouting() — Method in class AppEngineHttpRequest
- Task-level setting for App Engine routing.
- AppEngineHttpRequest::getRelativeUrl() — Method in class AppEngineHttpRequest
- The relative URL.
- AppEngineHttpRequest::getHeaders() — Method in class AppEngineHttpRequest
- HTTP request headers.
- AppEngineHttpRequest::getPayload() — Method in class AppEngineHttpRequest
- Payload.
- AppEngineHttpTarget::getAppEngineRoutingOverride() — Method in class AppEngineHttpTarget
- Overrides for the [task-level app_engine_routing][google.cloud.tasks.v2beta2.AppEngineHttpRequest.app_engine_routing].
- AppEngineRouting::getService() — Method in class AppEngineRouting
- App service.
- AppEngineRouting::getVersion() — Method in class AppEngineRouting
- App version.
- AppEngineRouting::getInstance() — Method in class AppEngineRouting
- App instance.
- AppEngineRouting::getHost() — Method in class AppEngineRouting
- Output only. The host that the task is sent to.
- AttemptStatus::getScheduleTime() — Method in class AttemptStatus
- Output only. The time that this attempt was scheduled.
- AttemptStatus::getDispatchTime() — Method in class AttemptStatus
- Output only. The time that this attempt was dispatched.
- AttemptStatus::getResponseTime() — Method in class AttemptStatus
- Output only. The time that this attempt response was received.
- AttemptStatus::getResponseStatus() — Method in class AttemptStatus
- Output only. The response from the target for this attempt.
- CancelLeaseRequest::getName() — Method in class CancelLeaseRequest
- Required.
- CancelLeaseRequest::getScheduleTime() — Method in class CancelLeaseRequest
- Required.
- CancelLeaseRequest::getResponseView() — Method in class CancelLeaseRequest
- The response_view specifies which subset of the [Task][google.cloud.tasks.v2beta2.Task] will be returned.
- CloudTasksGrpcClient::GetQueue() — Method in class CloudTasksGrpcClient
- Gets a queue.
- CloudTasksGrpcClient::GetIamPolicy() — Method in class CloudTasksGrpcClient
- Gets the access control policy for a [Queue][google.cloud.tasks.v2beta2.Queue].
- CloudTasksGrpcClient::GetTask() — Method in class CloudTasksGrpcClient
- Gets a task.
- CreateQueueRequest::getParent() — Method in class CreateQueueRequest
- Required.
- CreateQueueRequest::getQueue() — Method in class CreateQueueRequest
- Required.
- CreateTaskRequest::getParent() — Method in class CreateTaskRequest
- Required.
- CreateTaskRequest::getTask() — Method in class CreateTaskRequest
- Required.
- CreateTaskRequest::getResponseView() — Method in class CreateTaskRequest
- The response_view specifies which subset of the [Task][google.cloud.tasks.v2beta2.Task] will be returned.
- DeleteQueueRequest::getName() — Method in class DeleteQueueRequest
- Required.
- DeleteTaskRequest::getName() — Method in class DeleteTaskRequest
- Required.
- GetQueueRequest — Class in namespace Google\Cloud\Tasks\V2beta2
- Request message for [GetQueue][google.cloud.tasks.v2beta2.CloudTasks.GetQueue].
- GetQueueRequest::getName() — Method in class GetQueueRequest
- Required.
- GetTaskRequest — Class in namespace Google\Cloud\Tasks\V2beta2
- Request message for getting a task using [GetTask][google.cloud.tasks.v2beta2.CloudTasks.GetTask].
- GetTaskRequest::getName() — Method in class GetTaskRequest
- Required.
- GetTaskRequest::getResponseView() — Method in class GetTaskRequest
- The response_view specifies which subset of the [Task][google.cloud.tasks.v2beta2.Task] will be returned.
- LeaseTasksRequest::getParent() — Method in class LeaseTasksRequest
- Required.
- LeaseTasksRequest::getMaxTasks() — Method in class LeaseTasksRequest
- The maximum number of tasks to lease. The maximum that can be requested is 1000.
- LeaseTasksRequest::getLeaseDuration() — Method in class LeaseTasksRequest
- After the worker has successfully finished the work associated with the task, the worker must call via [AcknowledgeTask][google.cloud.tasks.v2beta2.CloudTasks.AcknowledgeTask] before the [schedule_time][google.cloud.tasks.v2beta2.Task.schedule_time]. Otherwise the task will be returned to a later [LeaseTasks][google.cloud.tasks.v2beta2.CloudTasks.LeaseTasks] call so that another worker can retry it.
- LeaseTasksRequest::getResponseView() — Method in class LeaseTasksRequest
- The response_view specifies which subset of the [Task][google.cloud.tasks.v2beta2.Task] will be returned.
- LeaseTasksRequest::getFilter() — Method in class LeaseTasksRequest
filtercan be used to specify a subset of tasks to lease.- LeaseTasksResponse::getTasks() — Method in class LeaseTasksResponse
- The leased tasks.
- ListQueuesRequest::getParent() — Method in class ListQueuesRequest
- Required.
- ListQueuesRequest::getFilter() — Method in class ListQueuesRequest
filtercan be used to specify a subset of queues. Any [Queue][google.cloud.tasks.v2beta2.Queue] field can be used as a filter and several operators as supported.- ListQueuesRequest::getPageSize() — Method in class ListQueuesRequest
- Requested page size.
- ListQueuesRequest::getPageToken() — Method in class ListQueuesRequest
- A token identifying the page of results to return.
- ListQueuesResponse::getQueues() — Method in class ListQueuesResponse
- The list of queues.
- ListQueuesResponse::getNextPageToken() — Method in class ListQueuesResponse
- A token to retrieve next page of results.
- ListTasksRequest::getParent() — Method in class ListTasksRequest
- Required.
- ListTasksRequest::getResponseView() — Method in class ListTasksRequest
- The response_view specifies which subset of the [Task][google.cloud.tasks.v2beta2.Task] will be returned.
- ListTasksRequest::getOrderBy() — Method in class ListTasksRequest
- Sort order used for the query. The only fields supported for sorting
are
schedule_timeandpull_message.tag. All results will be returned in approximately ascending order. The default ordering is byschedule_time. - ListTasksRequest::getPageSize() — Method in class ListTasksRequest
- Requested page size. Fewer tasks than requested might be returned.
- ListTasksRequest::getPageToken() — Method in class ListTasksRequest
- A token identifying the page of results to return.
- ListTasksResponse::getTasks() — Method in class ListTasksResponse
- The list of tasks.
- ListTasksResponse::getNextPageToken() — Method in class ListTasksResponse
- A token to retrieve next page of results.
- PauseQueueRequest::getName() — Method in class PauseQueueRequest
- Required.
- PullMessage::getPayload() — Method in class PullMessage
- A data payload consumed by the worker to execute the task.
- PullMessage::getTag() — Method in class PullMessage
- The task's tag.
- PurgeQueueRequest::getName() — Method in class PurgeQueueRequest
- Required.
- Queue::getName() — Method in class Queue
- The queue name.
- Queue::getAppEngineHttpTarget() — Method in class Queue
- App Engine HTTP target.
- Queue::getPullTarget() — Method in class Queue
- Pull target.
- Queue::getRateLimits() — Method in class Queue
- Rate limits for task dispatches.
- Queue::getRetryConfig() — Method in class Queue
- Settings that determine the retry behavior.
- Queue::getState() — Method in class Queue
- Output only. The state of the queue.
- Queue::getPurgeTime() — Method in class Queue
- Output only. The last time this queue was purged.
- Queue::getTargetType() — Method in class Queue
- RateLimits::getMaxTasksDispatchedPerSecond() — Method in class RateLimits
- The maximum rate at which tasks are dispatched from this queue.
- RateLimits::getMaxBurstSize() — Method in class RateLimits
- Output only. The max burst size.
- RateLimits::getMaxConcurrentTasks() — Method in class RateLimits
- The maximum number of concurrent tasks that Cloud Tasks allows to be dispatched for this queue. After this threshold has been reached, Cloud Tasks stops dispatching tasks until the number of concurrent requests decreases.
- RenewLeaseRequest::getName() — Method in class RenewLeaseRequest
- Required.
- RenewLeaseRequest::getScheduleTime() — Method in class RenewLeaseRequest
- Required.
- RenewLeaseRequest::getLeaseDuration() — Method in class RenewLeaseRequest
- Required.
- RenewLeaseRequest::getResponseView() — Method in class RenewLeaseRequest
- The response_view specifies which subset of the [Task][google.cloud.tasks.v2beta2.Task] will be returned.
- ResumeQueueRequest::getName() — Method in class ResumeQueueRequest
- Required.
- RetryConfig::getMaxAttempts() — Method in class RetryConfig
- The maximum number of attempts for a task.
- RetryConfig::getUnlimitedAttempts() — Method in class RetryConfig
- If true, then the number of attempts is unlimited.
- RetryConfig::getMaxRetryDuration() — Method in class RetryConfig
- If positive,
max_retry_durationspecifies the time limit for retrying a failed task, measured from when the task was first attempted. Oncemax_retry_durationtime has passed and the task has been attempted [max_attempts][google.cloud.tasks.v2beta2.RetryConfig.max_attempts] times, no further attempts will be made and the task will be deleted. - RetryConfig::getMinBackoff() — Method in class RetryConfig
- A task will be scheduled for retry between [min_backoff][google.cloud.tasks.v2beta2.RetryConfig.min_backoff] and [max_backoff][google.cloud.tasks.v2beta2.RetryConfig.max_backoff] duration after it fails, if the queue's [RetryConfig][google.cloud.tasks.v2beta2.RetryConfig] specifies that the task should be retried.
- RetryConfig::getMaxBackoff() — Method in class RetryConfig
- A task will be scheduled for retry between [min_backoff][google.cloud.tasks.v2beta2.RetryConfig.min_backoff] and [max_backoff][google.cloud.tasks.v2beta2.RetryConfig.max_backoff] duration after it fails, if the queue's [RetryConfig][google.cloud.tasks.v2beta2.RetryConfig] specifies that the task should be retried.
- RetryConfig::getMaxDoublings() — Method in class RetryConfig
- The time between retries will double
max_doublingstimes. - RetryConfig::getNumAttempts() — Method in class RetryConfig
- RunTaskRequest::getName() — Method in class RunTaskRequest
- Required.
- RunTaskRequest::getResponseView() — Method in class RunTaskRequest
- The response_view specifies which subset of the [Task][google.cloud.tasks.v2beta2.Task] will be returned.
- Task::getName() — Method in class Task
- The task name.
- Task::getAppEngineHttpRequest() — Method in class Task
- App Engine HTTP request that is sent to the task's target. Can be set only if [app_engine_http_target][google.cloud.tasks.v2beta2.Queue.app_engine_http_target] is set on the queue.
- Task::getPullMessage() — Method in class Task
- [LeaseTasks][google.cloud.tasks.v2beta2.CloudTasks.LeaseTasks] to process the task. Can be set only if [pull_target][google.cloud.tasks.v2beta2.Queue.pull_target] is set on the queue.
- Task::getScheduleTime() — Method in class Task
- The time when the task is scheduled to be attempted.
- Task::getCreateTime() — Method in class Task
- Output only. The time that the task was created.
- Task::getStatus() — Method in class Task
- Output only. The task status.
- Task::getView() — Method in class Task
- Output only. The view specifies which subset of the [Task][google.cloud.tasks.v2beta2.Task] has been returned.
- Task::getPayloadType() — Method in class Task
- TaskStatus::getAttemptDispatchCount() — Method in class TaskStatus
- Output only. The number of attempts dispatched.
- TaskStatus::getAttemptResponseCount() — Method in class TaskStatus
- Output only. The number of attempts which have received a response.
- TaskStatus::getFirstAttemptStatus() — Method in class TaskStatus
- Output only. The status of the task's first attempt.
- TaskStatus::getLastAttemptStatus() — Method in class TaskStatus
- Output only. The status of the task's last attempt.
- UpdateQueueRequest::getQueue() — Method in class UpdateQueueRequest
- Required.
- UpdateQueueRequest::getUpdateMask() — Method in class UpdateQueueRequest
- A mask used to specify which fields of the queue are being updated.
- AttributeValue::getStringValue() — Method in class AttributeValue
- A string up to 256 bytes long.
- AttributeValue::getIntValue() — Method in class AttributeValue
- A 64-bit signed integer.
- AttributeValue::getBoolValue() — Method in class AttributeValue
- A Boolean value represented by
trueorfalse. - AttributeValue::getValue() — Method in class AttributeValue
- BatchWriteSpansRequest::getName() — Method in class BatchWriteSpansRequest
- Required. The name of the project where the spans belong. The format is
projects/[PROJECT_ID]. - BatchWriteSpansRequest::getSpans() — Method in class BatchWriteSpansRequest
- A list of new spans. The span names must not match existing spans, or the results are undefined.
- Module::getModule() — Method in class Module
- For example: main binary, kernel modules, and dynamic libraries such as libc.so, sharedlib.so (up to 256 bytes).
- Module::getBuildId() — Method in class Module
- A unique identifier for the module, usually a hash of its contents (up to 128 bytes).
- Span::getName() — Method in class Span
- The resource name of the span in the following format: projects/[PROJECT_ID]/traces/[TRACE_ID]/spans/[SPAN_ID] [TRACE_ID] is a unique identifier for a trace within a project; it is a 32-character hexadecimal encoding of a 16-byte array.
- Span::getSpanId() — Method in class Span
- The [SPAN_ID] portion of the span's resource name.
- Span::getParentSpanId() — Method in class Span
- The [SPAN_ID] of this span's parent span. If this is a root span, then this field must be empty.
- Span::getDisplayName() — Method in class Span
- A description of the span's operation (up to 128 bytes).
- Span::getStartTime() — Method in class Span
- The start time of the span. On the client side, this is the time kept by the local machine where the span execution starts. On the server side, this is the time when the server's application handler starts running.
- Span::getEndTime() — Method in class Span
- The end time of the span. On the client side, this is the time kept by the local machine where the span execution ends. On the server side, this is the time when the server application handler stops running.
- Span::getAttributes() — Method in class Span
- A set of attributes on the span. You can have up to 32 attributes per span.
- Span::getStackTrace() — Method in class Span
- Stack trace captured at the start of the span.
- Span::getTimeEvents() — Method in class Span
- A set of time events. You can have up to 32 annotations and 128 message events per span.
- Span::getLinks() — Method in class Span
- Links associated with the span. You can have up to 128 links per Span.
- Span::getStatus() — Method in class Span
- An optional final status for this span.
- Span::getSameProcessAsParentSpan() — Method in class Span
- (Optional) Set this parameter to indicate whether this span is in the same process as its parent. If you do not set this parameter, Stackdriver Trace is unable to take advantage of this helpful information.
- Span::getChildSpanCount() — Method in class Span
- An optional number of child spans that were generated while this span was active. If set, allows implementation to detect missing child spans.
- Span_Attributes::getAttributeMap() — Method in class Span_Attributes
- The set of attributes. Each attribute's key can be up to 128 bytes
long. The value can be a string up to 256 bytes, an integer, or the
Boolean values
trueandfalse. For example: "/instance_id": "my-instance" "/http/user_agent": "" "/http/request_bytes": 300 "abc.com/myattribute": true - Span_Attributes::getDroppedAttributesCount() — Method in class Span_Attributes
- The number of attributes that were discarded. Attributes can be discarded because their keys are too long or because there are too many attributes.
- Span_Link::getTraceId() — Method in class Span_Link
- The [TRACE_ID] for a trace within a project.
- Span_Link::getSpanId() — Method in class Span_Link
- The [SPAN_ID] for a span within a trace.
- Span_Link::getType() — Method in class Span_Link
- The relationship of the current span relative to the linked span.
- Span_Link::getAttributes() — Method in class Span_Link
- A set of attributes on the link. You have have up to 32 attributes per link.
- Span_Links::getLink() — Method in class Span_Links
- A collection of links.
- Span_Links::getDroppedLinksCount() — Method in class Span_Links
- The number of dropped links after the maximum size was enforced. If this value is 0, then no links were dropped.
- Span_TimeEvent::getTime() — Method in class Span_TimeEvent
- The timestamp indicating the time the event occurred.
- Span_TimeEvent::getAnnotation() — Method in class Span_TimeEvent
- Text annotation with a set of attributes.
- Span_TimeEvent::getMessageEvent() — Method in class Span_TimeEvent
- An event describing a message sent/received between Spans.
- Span_TimeEvent::getValue() — Method in class Span_TimeEvent
- Span_TimeEvent_Annotation::getDescription() — Method in class Span_TimeEvent_Annotation
- A user-supplied message describing the event. The maximum length for the description is 256 bytes.
- Span_TimeEvent_Annotation::getAttributes() — Method in class Span_TimeEvent_Annotation
- A set of attributes on the annotation. You can have up to 4 attributes per Annotation.
- Span_TimeEvent_MessageEvent::getType() — Method in class Span_TimeEvent_MessageEvent
- Type of MessageEvent. Indicates whether the message was sent or received.
- Span_TimeEvent_MessageEvent::getId() — Method in class Span_TimeEvent_MessageEvent
- An identifier for the MessageEvent's message that can be used to match SENT and RECEIVED MessageEvents. It is recommended to be unique within a Span.
- Span_TimeEvent_MessageEvent::getUncompressedSizeBytes() — Method in class Span_TimeEvent_MessageEvent
- The number of uncompressed bytes sent or received.
- Span_TimeEvent_MessageEvent::getCompressedSizeBytes() — Method in class Span_TimeEvent_MessageEvent
- The number of compressed bytes sent or received. If missing assumed to be the same size as uncompressed.
- Span_TimeEvents::getTimeEvent() — Method in class Span_TimeEvents
- A collection of
TimeEvents. - Span_TimeEvents::getDroppedAnnotationsCount() — Method in class Span_TimeEvents
- The number of dropped annotations in all the included time events.
- Span_TimeEvents::getDroppedMessageEventsCount() — Method in class Span_TimeEvents
- The number of dropped message events in all the included time events.
- StackTrace::getStackFrames() — Method in class StackTrace
- Stack frames in this stack trace. A maximum of 128 frames are allowed.
- StackTrace::getStackTraceHashId() — Method in class StackTrace
- The hash ID is used to conserve network bandwidth for duplicate stack traces within a single trace.
- StackTrace_StackFrame::getFunctionName() — Method in class StackTrace_StackFrame
- The fully-qualified name that uniquely identifies the function or method that is active in this frame (up to 1024 bytes).
- StackTrace_StackFrame::getOriginalFunctionName() — Method in class StackTrace_StackFrame
- An un-mangled function name, if
function_nameis mangled. The name can be fully-qualified (up to 1024 bytes). - StackTrace_StackFrame::getFileName() — Method in class StackTrace_StackFrame
- The name of the source file where the function call appears (up to 256 bytes).
- StackTrace_StackFrame::getLineNumber() — Method in class StackTrace_StackFrame
- The line number in
file_namewhere the function call appears. - StackTrace_StackFrame::getColumnNumber() — Method in class StackTrace_StackFrame
- The column number where the function call appears, if available.
- StackTrace_StackFrame::getLoadModule() — Method in class StackTrace_StackFrame
- The binary module from where the code was loaded.
- StackTrace_StackFrame::getSourceVersion() — Method in class StackTrace_StackFrame
- The version of the deployed source code (up to 128 bytes).
- StackTrace_StackFrames::getFrame() — Method in class StackTrace_StackFrames
- Stack frames in this call stack.
- StackTrace_StackFrames::getDroppedFramesCount() — Method in class StackTrace_StackFrames
- The number of stack frames that were dropped because there were too many stack frames.
- TruncatableString::getValue() — Method in class TruncatableString
- The shortened string. For example, if the original string is 500
bytes long and the limit of the string is 128 bytes, then
valuecontains the first 128 bytes of the 500-byte string. - TruncatableString::getTruncatedByteCount() — Method in class TruncatableString
- The number of bytes removed from the original string. If this value is 0, then the string was not shortened.
- AnnotateVideoProgress::getAnnotationProgress() — Method in class AnnotateVideoProgress
- Progress metadata for all videos specified in
AnnotateVideoRequest. - AnnotateVideoRequest::getInputUri() — Method in class AnnotateVideoRequest
- Input video location. Currently, only
Google Cloud Storage URIs are
supported, which must be specified in the following format:
gs://bucket-id/object-id(other URI formats return [google.rpc.Code.INVALID_ARGUMENT][google.rpc.Code.INVALID_ARGUMENT]). For more information, see Request URIs. - AnnotateVideoRequest::getInputContent() — Method in class AnnotateVideoRequest
- The video data bytes.
- AnnotateVideoRequest::getFeatures() — Method in class AnnotateVideoRequest
- Requested video annotation features.
- AnnotateVideoRequest::getVideoContext() — Method in class AnnotateVideoRequest
- Additional video context and/or feature-specific parameters.
- AnnotateVideoRequest::getOutputUri() — Method in class AnnotateVideoRequest
- Optional location where the output (in JSON format) should be stored.
- AnnotateVideoRequest::getLocationId() — Method in class AnnotateVideoRequest
- Optional cloud region where annotation should take place. Supported cloud
regions:
us-east1,us-west1,europe-west1,asia-east1. If no region is specified, a region will be determined based on video file location. - AnnotateVideoResponse::getAnnotationResults() — Method in class AnnotateVideoResponse
- Annotation results for all videos specified in
AnnotateVideoRequest. - Entity::getEntityId() — Method in class Entity
- Opaque entity ID. Some IDs may be available in Google Knowledge Graph Search API.
- Entity::getDescription() — Method in class Entity
- Textual description, e.g.
Fixed-gear bicycle. - Entity::getLanguageCode() — Method in class Entity
- Language code for
descriptionin BCP-47 format. - ExplicitContentAnnotation::getFrames() — Method in class ExplicitContentAnnotation
- All video frames where explicit content was detected.
- ExplicitContentDetectionConfig::getModel() — Method in class ExplicitContentDetectionConfig
- Model to use for explicit content detection.
- ExplicitContentFrame::getTimeOffset() — Method in class ExplicitContentFrame
- Time-offset, relative to the beginning of the video, corresponding to the video frame for this location.
- ExplicitContentFrame::getPornographyLikelihood() — Method in class ExplicitContentFrame
- Likelihood of the pornography content.
- FaceAnnotation::getThumbnail() — Method in class FaceAnnotation
- Thumbnail of a representative face view (in JPEG format).
- FaceAnnotation::getSegments() — Method in class FaceAnnotation
- All video segments where a face was detected.
- FaceAnnotation::getFrames() — Method in class FaceAnnotation
- All video frames where a face was detected.
- FaceDetectionConfig::getModel() — Method in class FaceDetectionConfig
- Model to use for face detection.
- FaceDetectionConfig::getIncludeBoundingBoxes() — Method in class FaceDetectionConfig
- Whether bounding boxes be included in the face annotation output.
- FaceFrame::getNormalizedBoundingBoxes() — Method in class FaceFrame
- Normalized Bounding boxes in a frame.
- FaceFrame::getTimeOffset() — Method in class FaceFrame
- Time-offset, relative to the beginning of the video, corresponding to the video frame for this location.
- FaceSegment::getSegment() — Method in class FaceSegment
- Video segment where a face was detected.
- LabelAnnotation::getEntity() — Method in class LabelAnnotation
- Detected entity.
- LabelAnnotation::getCategoryEntities() — Method in class LabelAnnotation
- Common categories for the detected entity.
- LabelAnnotation::getSegments() — Method in class LabelAnnotation
- All video segments where a label was detected.
- LabelAnnotation::getFrames() — Method in class LabelAnnotation
- All video frames where a label was detected.
- LabelDetectionConfig::getLabelDetectionMode() — Method in class LabelDetectionConfig
- What labels should be detected with LABEL_DETECTION, in addition to video-level labels or segment-level labels.
- LabelDetectionConfig::getStationaryCamera() — Method in class LabelDetectionConfig
- Whether the video has been shot from a stationary (i.e. non-moving) camera.
- LabelDetectionConfig::getModel() — Method in class LabelDetectionConfig
- Model to use for label detection.
- LabelFrame::getTimeOffset() — Method in class LabelFrame
- Time-offset, relative to the beginning of the video, corresponding to the video frame for this location.
- LabelFrame::getConfidence() — Method in class LabelFrame
- Confidence that the label is accurate. Range: [0, 1].
- LabelSegment::getSegment() — Method in class LabelSegment
- Video segment where a label was detected.
- LabelSegment::getConfidence() — Method in class LabelSegment
- Confidence that the label is accurate. Range: [0, 1].
- NormalizedBoundingBox::getLeft() — Method in class NormalizedBoundingBox
- Left X coordinate.
- NormalizedBoundingBox::getTop() — Method in class NormalizedBoundingBox
- Top Y coordinate.
- NormalizedBoundingBox::getRight() — Method in class NormalizedBoundingBox
- Right X coordinate.
- NormalizedBoundingBox::getBottom() — Method in class NormalizedBoundingBox
- Bottom Y coordinate.
- ShotChangeDetectionConfig::getModel() — Method in class ShotChangeDetectionConfig
- Model to use for shot change detection.
- VideoAnnotationProgress::getInputUri() — Method in class VideoAnnotationProgress
- Video file location in Google Cloud Storage.
- VideoAnnotationProgress::getProgressPercent() — Method in class VideoAnnotationProgress
- Approximate percentage processed thus far.
- VideoAnnotationProgress::getStartTime() — Method in class VideoAnnotationProgress
- Time when the request was received.
- VideoAnnotationProgress::getUpdateTime() — Method in class VideoAnnotationProgress
- Time of the most recent update.
- VideoAnnotationResults::getInputUri() — Method in class VideoAnnotationResults
- Video file location in Google Cloud Storage.
- VideoAnnotationResults::getSegmentLabelAnnotations() — Method in class VideoAnnotationResults
- Label annotations on video level or user specified segment level.
- VideoAnnotationResults::getShotLabelAnnotations() — Method in class VideoAnnotationResults
- Label annotations on shot level.
- VideoAnnotationResults::getFrameLabelAnnotations() — Method in class VideoAnnotationResults
- Label annotations on frame level.
- VideoAnnotationResults::getFaceAnnotations() — Method in class VideoAnnotationResults
- Face annotations. There is exactly one element for each unique face.
- VideoAnnotationResults::getShotAnnotations() — Method in class VideoAnnotationResults
- Shot annotations. Each shot is represented as a video segment.
- VideoAnnotationResults::getExplicitAnnotation() — Method in class VideoAnnotationResults
- Explicit content annotation.
- VideoAnnotationResults::getError() — Method in class VideoAnnotationResults
- If set, indicates an error. Note that for a single
AnnotateVideoRequestsome videos may succeed and some may fail. - VideoContext::getSegments() — Method in class VideoContext
- Video segments to annotate. The segments may overlap and are not required to be contiguous or span the whole video. If unspecified, each video is treated as a single segment.
- VideoContext::getLabelDetectionConfig() — Method in class VideoContext
- Config for LABEL_DETECTION.
- VideoContext::getShotChangeDetectionConfig() — Method in class VideoContext
- Config for SHOT_CHANGE_DETECTION.
- VideoContext::getExplicitContentDetectionConfig() — Method in class VideoContext
- Config for EXPLICIT_CONTENT_DETECTION.
- VideoContext::getFaceDetectionConfig() — Method in class VideoContext
- Config for FACE_DETECTION.
- VideoSegment::getStartTimeOffset() — Method in class VideoSegment
- Time-offset, relative to the beginning of the video, corresponding to the start of the segment (inclusive).
- VideoSegment::getEndTimeOffset() — Method in class VideoSegment
- Time-offset, relative to the beginning of the video, corresponding to the end of the segment (inclusive).
- AnnotateVideoProgress::getAnnotationProgress() — Method in class AnnotateVideoProgress
- Progress metadata for all videos specified in
AnnotateVideoRequest. - AnnotateVideoRequest::getInputUri() — Method in class AnnotateVideoRequest
- Input video location. Currently, only
Google Cloud Storage URIs are
supported, which must be specified in the following format:
gs://bucket-id/object-id(other URI formats return [google.rpc.Code.INVALID_ARGUMENT][google.rpc.Code.INVALID_ARGUMENT]). For more information, see Request URIs. - AnnotateVideoRequest::getInputContent() — Method in class AnnotateVideoRequest
- The video data bytes. Encoding: base64. If unset, the input video(s)
should be specified via
input_uri. If set,input_urishould be unset. - AnnotateVideoRequest::getFeatures() — Method in class AnnotateVideoRequest
- Requested video annotation features.
- AnnotateVideoRequest::getVideoContext() — Method in class AnnotateVideoRequest
- Additional video context and/or feature-specific parameters.
- AnnotateVideoRequest::getOutputUri() — Method in class AnnotateVideoRequest
- Optional location where the output (in JSON format) should be stored.
- AnnotateVideoRequest::getLocationId() — Method in class AnnotateVideoRequest
- Optional cloud region where annotation should take place. Supported cloud
regions:
us-east1,us-west1,europe-west1,asia-east1. If no region is specified, a region will be determined based on video file location. - AnnotateVideoResponse::getAnnotationResults() — Method in class AnnotateVideoResponse
- Annotation results for all videos specified in
AnnotateVideoRequest. - BoundingBox::getLeft() — Method in class BoundingBox
- Left X coordinate.
- BoundingBox::getRight() — Method in class BoundingBox
- Right X coordinate.
- BoundingBox::getBottom() — Method in class BoundingBox
- Bottom Y coordinate.
- BoundingBox::getTop() — Method in class BoundingBox
- Top Y coordinate.
- FaceAnnotation::getThumbnail() — Method in class FaceAnnotation
- Thumbnail of a representative face view (in JPEG format). Encoding: base64.
- FaceAnnotation::getSegments() — Method in class FaceAnnotation
- All locations where a face was detected.
- FaceAnnotation::getLocations() — Method in class FaceAnnotation
- Face locations at one frame per second.
- FaceLocation::getBoundingBox() — Method in class FaceLocation
- Bounding box in a frame.
- FaceLocation::getTimeOffset() — Method in class FaceLocation
- Video time offset in microseconds.
- LabelAnnotation::getDescription() — Method in class LabelAnnotation
- Textual description, e.g.
Fixed-gear bicycle. - LabelAnnotation::getLanguageCode() — Method in class LabelAnnotation
- Language code for
descriptionin BCP-47 format. - LabelAnnotation::getLocations() — Method in class LabelAnnotation
- Where the label was detected and with what confidence.
- LabelLocation::getSegment() — Method in class LabelLocation
- Video segment. Set to [-1, -1] for video-level labels.
- LabelLocation::getConfidence() — Method in class LabelLocation
- Confidence that the label is accurate. Range: [0, 1].
- LabelLocation::getLevel() — Method in class LabelLocation
- Label level.
- SafeSearchAnnotation::getAdult() — Method in class SafeSearchAnnotation
- Likelihood of adult content.
- SafeSearchAnnotation::getSpoof() — Method in class SafeSearchAnnotation
- Likelihood that an obvious modification was made to the original version to make it appear funny or offensive.
- SafeSearchAnnotation::getMedical() — Method in class SafeSearchAnnotation
- Likelihood of medical content.
- SafeSearchAnnotation::getViolent() — Method in class SafeSearchAnnotation
- Likelihood of violent content.
- SafeSearchAnnotation::getRacy() — Method in class SafeSearchAnnotation
- Likelihood of racy content.
- SafeSearchAnnotation::getTimeOffset() — Method in class SafeSearchAnnotation
- Video time offset in microseconds.
- VideoAnnotationProgress::getInputUri() — Method in class VideoAnnotationProgress
- Video file location in Google Cloud Storage.
- VideoAnnotationProgress::getProgressPercent() — Method in class VideoAnnotationProgress
- Approximate percentage processed thus far.
- VideoAnnotationProgress::getStartTime() — Method in class VideoAnnotationProgress
- Time when the request was received.
- VideoAnnotationProgress::getUpdateTime() — Method in class VideoAnnotationProgress
- Time of the most recent update.
- VideoAnnotationResults::getInputUri() — Method in class VideoAnnotationResults
- Video file location in Google Cloud Storage.
- VideoAnnotationResults::getLabelAnnotations() — Method in class VideoAnnotationResults
- Label annotations. There is exactly one element for each unique label.
- VideoAnnotationResults::getFaceAnnotations() — Method in class VideoAnnotationResults
- Face annotations. There is exactly one element for each unique face.
- VideoAnnotationResults::getShotAnnotations() — Method in class VideoAnnotationResults
- Shot annotations. Each shot is represented as a video segment.
- VideoAnnotationResults::getSafeSearchAnnotations() — Method in class VideoAnnotationResults
- Safe search annotations.
- VideoAnnotationResults::getError() — Method in class VideoAnnotationResults
- If set, indicates an error. Note that for a single
AnnotateVideoRequestsome videos may succeed and some may fail. - VideoContext::getSegments() — Method in class VideoContext
- Video segments to annotate. The segments may overlap and are not required to be contiguous or span the whole video. If unspecified, each video is treated as a single segment.
- VideoContext::getLabelDetectionMode() — Method in class VideoContext
- If label detection has been requested, what labels should be detected
in addition to video-level labels or segment-level labels. If unspecified,
defaults to
SHOT_MODE. - VideoContext::getStationaryCamera() — Method in class VideoContext
- Whether the video has been shot from a stationary (i.e. non-moving) camera.
- VideoContext::getLabelDetectionModel() — Method in class VideoContext
- Model to use for label detection.
- VideoContext::getFaceDetectionModel() — Method in class VideoContext
- Model to use for face detection.
- VideoContext::getShotChangeDetectionModel() — Method in class VideoContext
- Model to use for shot change detection.
- VideoContext::getSafeSearchDetectionModel() — Method in class VideoContext
- Model to use for safe search detection.
- VideoSegment::getStartTimeOffset() — Method in class VideoSegment
- Start offset in microseconds (inclusive). Unset means 0.
- VideoSegment::getEndTimeOffset() — Method in class VideoSegment
- End offset in microseconds (inclusive). Unset means 0.
- AnnotateVideoProgress::getAnnotationProgress() — Method in class AnnotateVideoProgress
- Progress metadata for all videos specified in
AnnotateVideoRequest. - AnnotateVideoRequest::getInputUri() — Method in class AnnotateVideoRequest
- Input video location. Currently, only
Google Cloud Storage URIs are
supported, which must be specified in the following format:
gs://bucket-id/object-id(other URI formats return [google.rpc.Code.INVALID_ARGUMENT][google.rpc.Code.INVALID_ARGUMENT]). For more information, see Request URIs. - AnnotateVideoRequest::getInputContent() — Method in class AnnotateVideoRequest
- The video data bytes.
- AnnotateVideoRequest::getFeatures() — Method in class AnnotateVideoRequest
- Requested video annotation features.
- AnnotateVideoRequest::getVideoContext() — Method in class AnnotateVideoRequest
- Additional video context and/or feature-specific parameters.
- AnnotateVideoRequest::getOutputUri() — Method in class AnnotateVideoRequest
- Optional location where the output (in JSON format) should be stored.
- AnnotateVideoRequest::getLocationId() — Method in class AnnotateVideoRequest
- Optional cloud region where annotation should take place. Supported cloud
regions:
us-east1,us-west1,europe-west1,asia-east1. If no region is specified, a region will be determined based on video file location. - AnnotateVideoResponse::getAnnotationResults() — Method in class AnnotateVideoResponse
- Annotation results for all videos specified in
AnnotateVideoRequest. - Entity::getEntityId() — Method in class Entity
- Opaque entity ID. Some IDs may be available in Google Knowledge Graph Search API.
- Entity::getDescription() — Method in class Entity
- Textual description, e.g.
Fixed-gear bicycle. - Entity::getLanguageCode() — Method in class Entity
- Language code for
descriptionin BCP-47 format. - ExplicitContentAnnotation::getFrames() — Method in class ExplicitContentAnnotation
- All video frames where explicit content was detected.
- ExplicitContentDetectionConfig::getModel() — Method in class ExplicitContentDetectionConfig
- Model to use for explicit content detection.
- ExplicitContentFrame::getTimeOffset() — Method in class ExplicitContentFrame
- Time-offset, relative to the beginning of the video, corresponding to the video frame for this location.
- ExplicitContentFrame::getPornographyLikelihood() — Method in class ExplicitContentFrame
- Likelihood of the pornography content.
- FaceAnnotation::getThumbnail() — Method in class FaceAnnotation
- Thumbnail of a representative face view (in JPEG format).
- FaceAnnotation::getSegments() — Method in class FaceAnnotation
- All video segments where a face was detected.
- FaceAnnotation::getFrames() — Method in class FaceAnnotation
- All video frames where a face was detected.
- FaceDetectionConfig::getModel() — Method in class FaceDetectionConfig
- Model to use for face detection.
- FaceDetectionConfig::getIncludeBoundingBoxes() — Method in class FaceDetectionConfig
- Whether bounding boxes be included in the face annotation output.
- FaceFrame::getNormalizedBoundingBoxes() — Method in class FaceFrame
- Normalized Bounding boxes in a frame.
- FaceFrame::getTimeOffset() — Method in class FaceFrame
- Time-offset, relative to the beginning of the video, corresponding to the video frame for this location.
- FaceSegment::getSegment() — Method in class FaceSegment
- Video segment where a face was detected.
- LabelAnnotation::getEntity() — Method in class LabelAnnotation
- Detected entity.
- LabelAnnotation::getCategoryEntities() — Method in class LabelAnnotation
- Common categories for the detected entity.
- LabelAnnotation::getSegments() — Method in class LabelAnnotation
- All video segments where a label was detected.
- LabelAnnotation::getFrames() — Method in class LabelAnnotation
- All video frames where a label was detected.
- LabelDetectionConfig::getLabelDetectionMode() — Method in class LabelDetectionConfig
- What labels should be detected with LABEL_DETECTION, in addition to video-level labels or segment-level labels.
- LabelDetectionConfig::getStationaryCamera() — Method in class LabelDetectionConfig
- Whether the video has been shot from a stationary (i.e. non-moving) camera.
- LabelDetectionConfig::getModel() — Method in class LabelDetectionConfig
- Model to use for label detection.
- LabelFrame::getTimeOffset() — Method in class LabelFrame
- Time-offset, relative to the beginning of the video, corresponding to the video frame for this location.
- LabelFrame::getConfidence() — Method in class LabelFrame
- Confidence that the label is accurate. Range: [0, 1].
- LabelSegment::getSegment() — Method in class LabelSegment
- Video segment where a label was detected.
- LabelSegment::getConfidence() — Method in class LabelSegment
- Confidence that the label is accurate. Range: [0, 1].
- NormalizedBoundingBox::getLeft() — Method in class NormalizedBoundingBox
- Left X coordinate.
- NormalizedBoundingBox::getTop() — Method in class NormalizedBoundingBox
- Top Y coordinate.
- NormalizedBoundingBox::getRight() — Method in class NormalizedBoundingBox
- Right X coordinate.
- NormalizedBoundingBox::getBottom() — Method in class NormalizedBoundingBox
- Bottom Y coordinate.
- ShotChangeDetectionConfig::getModel() — Method in class ShotChangeDetectionConfig
- Model to use for shot change detection.
- VideoAnnotationProgress::getInputUri() — Method in class VideoAnnotationProgress
- Video file location in Google Cloud Storage.
- VideoAnnotationProgress::getProgressPercent() — Method in class VideoAnnotationProgress
- Approximate percentage processed thus far.
- VideoAnnotationProgress::getStartTime() — Method in class VideoAnnotationProgress
- Time when the request was received.
- VideoAnnotationProgress::getUpdateTime() — Method in class VideoAnnotationProgress
- Time of the most recent update.
- VideoAnnotationResults::getInputUri() — Method in class VideoAnnotationResults
- Video file location in Google Cloud Storage.
- VideoAnnotationResults::getSegmentLabelAnnotations() — Method in class VideoAnnotationResults
- Label annotations on video level or user specified segment level.
- VideoAnnotationResults::getShotLabelAnnotations() — Method in class VideoAnnotationResults
- Label annotations on shot level.
- VideoAnnotationResults::getFrameLabelAnnotations() — Method in class VideoAnnotationResults
- Label annotations on frame level.
- VideoAnnotationResults::getFaceAnnotations() — Method in class VideoAnnotationResults
- Face annotations. There is exactly one element for each unique face.
- VideoAnnotationResults::getShotAnnotations() — Method in class VideoAnnotationResults
- Shot annotations. Each shot is represented as a video segment.
- VideoAnnotationResults::getExplicitAnnotation() — Method in class VideoAnnotationResults
- Explicit content annotation.
- VideoAnnotationResults::getError() — Method in class VideoAnnotationResults
- If set, indicates an error. Note that for a single
AnnotateVideoRequestsome videos may succeed and some may fail. - VideoContext::getSegments() — Method in class VideoContext
- Video segments to annotate. The segments may overlap and are not required to be contiguous or span the whole video. If unspecified, each video is treated as a single segment.
- VideoContext::getLabelDetectionConfig() — Method in class VideoContext
- Config for LABEL_DETECTION.
- VideoContext::getShotChangeDetectionConfig() — Method in class VideoContext
- Config for SHOT_CHANGE_DETECTION.
- VideoContext::getExplicitContentDetectionConfig() — Method in class VideoContext
- Config for EXPLICIT_CONTENT_DETECTION.
- VideoContext::getFaceDetectionConfig() — Method in class VideoContext
- Config for FACE_DETECTION.
- VideoSegment::getStartTimeOffset() — Method in class VideoSegment
- Time-offset, relative to the beginning of the video, corresponding to the start of the segment (inclusive).
- VideoSegment::getEndTimeOffset() — Method in class VideoSegment
- Time-offset, relative to the beginning of the video, corresponding to the end of the segment (inclusive).
- AnnotateFileResponse::getInputConfig() — Method in class AnnotateFileResponse
- Information about the file for which this response is generated.
- AnnotateFileResponse::getResponses() — Method in class AnnotateFileResponse
- Individual responses to images found within the file.
- AnnotateImageRequest::getImage() — Method in class AnnotateImageRequest
- The image to be processed.
- AnnotateImageRequest::getFeatures() — Method in class AnnotateImageRequest
- Requested features.
- AnnotateImageRequest::getImageContext() — Method in class AnnotateImageRequest
- Additional context that may accompany the image.
- AnnotateImageResponse::getFaceAnnotations() — Method in class AnnotateImageResponse
- If present, face detection has completed successfully.
- AnnotateImageResponse::getLandmarkAnnotations() — Method in class AnnotateImageResponse
- If present, landmark detection has completed successfully.
- AnnotateImageResponse::getLogoAnnotations() — Method in class AnnotateImageResponse
- If present, logo detection has completed successfully.
- AnnotateImageResponse::getLabelAnnotations() — Method in class AnnotateImageResponse
- If present, label detection has completed successfully.
- AnnotateImageResponse::getTextAnnotations() — Method in class AnnotateImageResponse
- If present, text (OCR) detection has completed successfully.
- AnnotateImageResponse::getFullTextAnnotation() — Method in class AnnotateImageResponse
- If present, text (OCR) detection or document (OCR) text detection has completed successfully.
- AnnotateImageResponse::getSafeSearchAnnotation() — Method in class AnnotateImageResponse
- If present, safe-search annotation has completed successfully.
- AnnotateImageResponse::getImagePropertiesAnnotation() — Method in class AnnotateImageResponse
- If present, image properties were extracted successfully.
- AnnotateImageResponse::getCropHintsAnnotation() — Method in class AnnotateImageResponse
- If present, crop hints have completed successfully.
- AnnotateImageResponse::getWebDetection() — Method in class AnnotateImageResponse
- If present, web detection has completed successfully.
- AnnotateImageResponse::getError() — Method in class AnnotateImageResponse
- If set, represents the error message for the operation.
- AnnotateImageResponse::getContext() — Method in class AnnotateImageResponse
- If present, contextual information is needed to understand where this image comes from.
- AsyncAnnotateFileRequest::getInputConfig() — Method in class AsyncAnnotateFileRequest
- Required. Information about the input file.
- AsyncAnnotateFileRequest::getFeatures() — Method in class AsyncAnnotateFileRequest
- Required. Requested features.
- AsyncAnnotateFileRequest::getImageContext() — Method in class AsyncAnnotateFileRequest
- Additional context that may accompany the image(s) in the file.
- AsyncAnnotateFileRequest::getOutputConfig() — Method in class AsyncAnnotateFileRequest
- Required. The desired output location and metadata (e.g. format).
- AsyncAnnotateFileResponse::getOutputConfig() — Method in class AsyncAnnotateFileResponse
- The output location and metadata from AsyncAnnotateFileRequest.
- AsyncBatchAnnotateFilesRequest::getRequests() — Method in class AsyncBatchAnnotateFilesRequest
- Individual async file annotation requests for this batch.
- AsyncBatchAnnotateFilesResponse::getResponses() — Method in class AsyncBatchAnnotateFilesResponse
- The list of file annotation responses, one for each request in AsyncBatchAnnotateFilesRequest.
- BatchAnnotateImagesRequest::getRequests() — Method in class BatchAnnotateImagesRequest
- Individual image annotation requests for this batch.
- BatchAnnotateImagesResponse::getResponses() — Method in class BatchAnnotateImagesResponse
- Individual responses to image annotation requests within the batch.
- Block::getProperty() — Method in class Block
- Additional information detected for the block.
- Block::getBoundingBox() — Method in class Block
- The bounding box for the block.
- Block::getParagraphs() — Method in class Block
- List of paragraphs in this block (if this blocks is of type text).
- Block::getBlockType() — Method in class Block
- Detected block type (text, image etc) for this block.
- Block::getConfidence() — Method in class Block
- Confidence of the OCR results on the block. Range [0, 1].
- BoundingPoly::getVertices() — Method in class BoundingPoly
- The bounding polygon vertices.
- BoundingPoly::getNormalizedVertices() — Method in class BoundingPoly
- The bounding polygon normalized vertices.
- ColorInfo::getColor() — Method in class ColorInfo
- RGB components of the color.
- ColorInfo::getScore() — Method in class ColorInfo
- Image-specific score for this color. Value in range [0, 1].
- ColorInfo::getPixelFraction() — Method in class ColorInfo
- The fraction of pixels the color occupies in the image.
- CropHint::getBoundingPoly() — Method in class CropHint
- The bounding polygon for the crop region. The coordinates of the bounding
box are in the original image's scale, as returned in
ImageParams. - CropHint::getConfidence() — Method in class CropHint
- Confidence of this being a salient region. Range [0, 1].
- CropHint::getImportanceFraction() — Method in class CropHint
- Fraction of importance of this salient region with respect to the original image.
- CropHintsAnnotation::getCropHints() — Method in class CropHintsAnnotation
- Crop hint results.
- CropHintsParams::getAspectRatios() — Method in class CropHintsParams
- Aspect ratios in floats, representing the ratio of the width to the height of the image. For example, if the desired aspect ratio is 4/3, the corresponding float value should be 1.33333. If not specified, the best possible crop is returned. The number of provided aspect ratios is limited to a maximum of 16; any aspect ratios provided after the 16th are ignored.
- DominantColorsAnnotation::getColors() — Method in class DominantColorsAnnotation
- RGB color values with their score and pixel fraction.
- EntityAnnotation::getMid() — Method in class EntityAnnotation
- Opaque entity ID. Some IDs may be available in Google Knowledge Graph Search API.
- EntityAnnotation::getLocale() — Method in class EntityAnnotation
- The language code for the locale in which the entity textual
descriptionis expressed. - EntityAnnotation::getDescription() — Method in class EntityAnnotation
- Entity textual description, expressed in its
localelanguage. - EntityAnnotation::getScore() — Method in class EntityAnnotation
- Overall score of the result. Range [0, 1].
- EntityAnnotation::getConfidence() — Method in class EntityAnnotation
- Deprecated. Use
scoreinstead. The accuracy of the entity detection in an image. - EntityAnnotation::getTopicality() — Method in class EntityAnnotation
- The relevancy of the ICA (Image Content Annotation) label to the image. For example, the relevancy of "tower" is likely higher to an image containing the detected "Eiffel Tower" than to an image containing a detected distant towering building, even though the confidence that there is a tower in each image may be the same. Range [0, 1].
- EntityAnnotation::getBoundingPoly() — Method in class EntityAnnotation
- Image region to which this entity belongs. Not produced
for
LABEL_DETECTIONfeatures. - EntityAnnotation::getLocations() — Method in class EntityAnnotation
- The location information for the detected entity. Multiple
LocationInfoelements can be present because one location may indicate the location of the scene in the image, and another location may indicate the location of the place where the image was taken. - EntityAnnotation::getProperties() — Method in class EntityAnnotation
- Some entities may have optional user-supplied
Property(name/value) fields, such a score or string that qualifies the entity. - FaceAnnotation::getBoundingPoly() — Method in class FaceAnnotation
- The bounding polygon around the face. The coordinates of the bounding box
are in the original image's scale, as returned in
ImageParams. - FaceAnnotation::getFdBoundingPoly() — Method in class FaceAnnotation
- The
fd_bounding_polybounding polygon is tighter than theboundingPoly, and encloses only the skin part of the face. Typically, it is used to eliminate the face from any image analysis that detects the "amount of skin" visible in an image. It is not based on the landmarker results, only on the initial face detection, hence thefd(face detection) prefix. - FaceAnnotation::getLandmarks() — Method in class FaceAnnotation
- Detected face landmarks.
- FaceAnnotation::getRollAngle() — Method in class FaceAnnotation
- Roll angle, which indicates the amount of clockwise/anti-clockwise rotation of the face relative to the image vertical about the axis perpendicular to the face. Range [-180,180].
- FaceAnnotation::getPanAngle() — Method in class FaceAnnotation
- Yaw angle, which indicates the leftward/rightward angle that the face is pointing relative to the vertical plane perpendicular to the image. Range [-180,180].
- FaceAnnotation::getTiltAngle() — Method in class FaceAnnotation
- Pitch angle, which indicates the upwards/downwards angle that the face is pointing relative to the image's horizontal plane. Range [-180,180].
- FaceAnnotation::getDetectionConfidence() — Method in class FaceAnnotation
- Detection confidence. Range [0, 1].
- FaceAnnotation::getLandmarkingConfidence() — Method in class FaceAnnotation
- Face landmarking confidence. Range [0, 1].
- FaceAnnotation::getJoyLikelihood() — Method in class FaceAnnotation
- Joy likelihood.
- FaceAnnotation::getSorrowLikelihood() — Method in class FaceAnnotation
- Sorrow likelihood.
- FaceAnnotation::getAngerLikelihood() — Method in class FaceAnnotation
- Anger likelihood.
- FaceAnnotation::getSurpriseLikelihood() — Method in class FaceAnnotation
- Surprise likelihood.
- FaceAnnotation::getUnderExposedLikelihood() — Method in class FaceAnnotation
- Under-exposed likelihood.
- FaceAnnotation::getBlurredLikelihood() — Method in class FaceAnnotation
- Blurred likelihood.
- FaceAnnotation::getHeadwearLikelihood() — Method in class FaceAnnotation
- Headwear likelihood.
- FaceAnnotation_Landmark::getType() — Method in class FaceAnnotation_Landmark
- Face landmark type.
- FaceAnnotation_Landmark::getPosition() — Method in class FaceAnnotation_Landmark
- Face landmark position.
- Feature::getType() — Method in class Feature
- The feature type.
- Feature::getMaxResults() — Method in class Feature
- Maximum number of results of this type. Does not apply to
TEXT_DETECTION,DOCUMENT_TEXT_DETECTION, orCROP_HINTS. - Feature::getModel() — Method in class Feature
- Model to use for the feature.
- GcsDestination — Class in namespace Google\Cloud\Vision\V1
- The Google Cloud Storage location where the output will be written to.
- GcsDestination::getUri() — Method in class GcsDestination
- Google Cloud Storage URI where the results will be stored. Results will be in JSON format and preceded by its corresponding input URI. This field can either represent a single file, or a prefix for multiple outputs.
- GcsSource — Class in namespace Google\Cloud\Vision\V1
- The Google Cloud Storage location where the input will be read from.
- GcsSource::getUri() — Method in class GcsSource
- Google Cloud Storage URI for the input file. This must only be a Google Cloud Storage object. Wildcards are not currently supported.
- Image::getContent() — Method in class Image
- Image content, represented as a stream of bytes.
- Image::getSource() — Method in class Image
- Google Cloud Storage image location, or publicly-accessible image
URL. If both
contentandsourceare provided for an image,contenttakes precedence and is used to perform the image annotation request. - ImageAnnotationContext::getUri() — Method in class ImageAnnotationContext
- The URI of the file used to produce the image.
- ImageAnnotationContext::getPageNumber() — Method in class ImageAnnotationContext
- If the file was a PDF or TIFF, this field gives the page number within the file used to produce the image.
- ImageContext::getLatLongRect() — Method in class ImageContext
- Not used.
- ImageContext::getLanguageHints() — Method in class ImageContext
- List of languages to use for TEXT_DETECTION. In most cases, an empty value
yields the best results since it enables automatic language detection. For
languages based on the Latin alphabet, setting
language_hintsis not needed. In rare cases, when the language of the text in the image is known, setting a hint will help get better results (although it will be a significant hindrance if the hint is wrong). Text detection returns an error if one or more of the specified languages is not one of the supported languages. - ImageContext::getCropHintsParams() — Method in class ImageContext
- Parameters for crop hints annotation request.
- ImageContext::getWebDetectionParams() — Method in class ImageContext
- Parameters for web detection.
- ImageProperties::getDominantColors() — Method in class ImageProperties
- If present, dominant colors completed successfully.
- ImageSource::getGcsImageUri() — Method in class ImageSource
- Use
image_uriinstead. The Google Cloud Storage URI of the formgs://bucket_name/object_name. Object versioning is not supported. See Google Cloud Storage Request URIs for more info. - ImageSource::getImageUri() — Method in class ImageSource
- The URI of the source image. Can be either:
1. A Google Cloud Storage URI of the form
gs://bucket_name/object_name. Object versioning is not supported. See Google Cloud Storage Request URIs for more info. - InputConfig::getGcsSource() — Method in class InputConfig
- The Google Cloud Storage location to read the input from.
- InputConfig::getMimeType() — Method in class InputConfig
- The type of the file. Currently only "application/pdf" and "image/tiff" are supported. Wildcards are not supported.
- LatLongRect::getMinLatLng() — Method in class LatLongRect
- Min lat/long pair.
- LatLongRect::getMaxLatLng() — Method in class LatLongRect
- Max lat/long pair.
- LocationInfo::getLatLng() — Method in class LocationInfo
- lat/long location coordinates.
- NormalizedVertex::getX() — Method in class NormalizedVertex
- X coordinate.
- NormalizedVertex::getY() — Method in class NormalizedVertex
- Y coordinate.
- OperationMetadata::getState() — Method in class OperationMetadata
- Current state of the batch operation.
- OperationMetadata::getCreateTime() — Method in class OperationMetadata
- The time when the batch request was received.
- OperationMetadata::getUpdateTime() — Method in class OperationMetadata
- The time when the operation result was last updated.
- OutputConfig::getGcsDestination() — Method in class OutputConfig
- The Google Cloud Storage location to write the output(s) to.
- OutputConfig::getBatchSize() — Method in class OutputConfig
- The max number of response protos to put into each output JSON file on Google Cloud Storage.
- Page::getProperty() — Method in class Page
- Additional information detected on the page.
- Page::getWidth() — Method in class Page
- Page width. For PDFs the unit is points. For images (including TIFFs) the unit is pixels.
- Page::getHeight() — Method in class Page
- Page height. For PDFs the unit is points. For images (including TIFFs) the unit is pixels.
- Page::getBlocks() — Method in class Page
- List of blocks of text, images etc on this page.
- Page::getConfidence() — Method in class Page
- Confidence of the OCR results on the page. Range [0, 1].
- Paragraph::getProperty() — Method in class Paragraph
- Additional information detected for the paragraph.
- Paragraph::getBoundingBox() — Method in class Paragraph
- The bounding box for the paragraph.
- Paragraph::getWords() — Method in class Paragraph
- List of words in this paragraph.
- Paragraph::getConfidence() — Method in class Paragraph
- Confidence of the OCR results for the paragraph. Range [0, 1].
- Position::getX() — Method in class Position
- X coordinate.
- Position::getY() — Method in class Position
- Y coordinate.
- Position::getZ() — Method in class Position
- Z coordinate (or depth).
- Property::getName() — Method in class Property
- Name of the property.
- Property::getValue() — Method in class Property
- Value of the property.
- Property::getUint64Value() — Method in class Property
- Value of numeric properties.
- SafeSearchAnnotation::getAdult() — Method in class SafeSearchAnnotation
- Represents the adult content likelihood for the image. Adult content may contain elements such as nudity, pornographic images or cartoons, or sexual activities.
- SafeSearchAnnotation::getSpoof() — Method in class SafeSearchAnnotation
- Spoof likelihood. The likelihood that an modification was made to the image's canonical version to make it appear funny or offensive.
- SafeSearchAnnotation::getMedical() — Method in class SafeSearchAnnotation
- Likelihood that this is a medical image.
- SafeSearchAnnotation::getViolence() — Method in class SafeSearchAnnotation
- Likelihood that this image contains violent content.
- SafeSearchAnnotation::getRacy() — Method in class SafeSearchAnnotation
- Likelihood that the request image contains racy content. Racy content may include (but is not limited to) skimpy or sheer clothing, strategically covered nudity, lewd or provocative poses, or close-ups of sensitive body areas.
- Symbol::getProperty() — Method in class Symbol
- Additional information detected for the symbol.
- Symbol::getBoundingBox() — Method in class Symbol
- The bounding box for the symbol.
- Symbol::getText() — Method in class Symbol
- The actual UTF-8 representation of the symbol.
- Symbol::getConfidence() — Method in class Symbol
- Confidence of the OCR results for the symbol. Range [0, 1].
- TextAnnotation::getPages() — Method in class TextAnnotation
- List of pages detected by OCR.
- TextAnnotation::getText() — Method in class TextAnnotation
- UTF-8 text detected on the pages.
- TextAnnotation_DetectedBreak::getType() — Method in class TextAnnotation_DetectedBreak
- Detected break type.
- TextAnnotation_DetectedBreak::getIsPrefix() — Method in class TextAnnotation_DetectedBreak
- True if break prepends the element.
- TextAnnotation_DetectedLanguage::getLanguageCode() — Method in class TextAnnotation_DetectedLanguage
- The BCP-47 language code, such as "en-US" or "sr-Latn". For more information, see http://www.unicode.org/reports/tr35/#Unicode_locale_identifier.
- TextAnnotation_DetectedLanguage::getConfidence() — Method in class TextAnnotation_DetectedLanguage
- Confidence of detected language. Range [0, 1].
- TextAnnotation_TextProperty::getDetectedLanguages() — Method in class TextAnnotation_TextProperty
- A list of detected languages together with confidence.
- TextAnnotation_TextProperty::getDetectedBreak() — Method in class TextAnnotation_TextProperty
- Detected start or end of a text segment.
- Vertex::getX() — Method in class Vertex
- X coordinate.
- Vertex::getY() — Method in class Vertex
- Y coordinate.
- WebDetection::getWebEntities() — Method in class WebDetection
- Deduced entities from similar images on the Internet.
- WebDetection::getFullMatchingImages() — Method in class WebDetection
- Fully matching images from the Internet.
- WebDetection::getPartialMatchingImages() — Method in class WebDetection
- Partial matching images from the Internet.
- WebDetection::getPagesWithMatchingImages() — Method in class WebDetection
- Web pages containing the matching images from the Internet.
- WebDetection::getVisuallySimilarImages() — Method in class WebDetection
- The visually similar image results.
- WebDetection::getBestGuessLabels() — Method in class WebDetection
- Best guess text labels for the request image.
- WebDetectionParams::getIncludeGeoResults() — Method in class WebDetectionParams
- Whether to include results derived from the geo information in the image.
- WebDetection_WebEntity::getEntityId() — Method in class WebDetection_WebEntity
- Opaque entity ID.
- WebDetection_WebEntity::getScore() — Method in class WebDetection_WebEntity
- Overall relevancy score for the entity.
- WebDetection_WebEntity::getDescription() — Method in class WebDetection_WebEntity
- Canonical description of the entity, in English.
- WebDetection_WebImage::getUrl() — Method in class WebDetection_WebImage
- The result image URL.
- WebDetection_WebImage::getScore() — Method in class WebDetection_WebImage
- (Deprecated) Overall relevancy score for the image.
- WebDetection_WebLabel::getLabel() — Method in class WebDetection_WebLabel
- Label for extra metadata.
- WebDetection_WebLabel::getLanguageCode() — Method in class WebDetection_WebLabel
- The BCP-47 language code for
label, such as "en-US" or "sr-Latn". - WebDetection_WebPage::getUrl() — Method in class WebDetection_WebPage
- The result web page URL.
- WebDetection_WebPage::getScore() — Method in class WebDetection_WebPage
- (Deprecated) Overall relevancy score for the web page.
- WebDetection_WebPage::getPageTitle() — Method in class WebDetection_WebPage
- Title for the web page, may contain HTML markups.
- WebDetection_WebPage::getFullMatchingImages() — Method in class WebDetection_WebPage
- Fully matching images on the page.
- WebDetection_WebPage::getPartialMatchingImages() — Method in class WebDetection_WebPage
- Partial matching images on the page.
- Word::getProperty() — Method in class Word
- Additional information detected for the word.
- Word::getBoundingBox() — Method in class Word
- The bounding box for the word.
- Word::getSymbols() — Method in class Word
- List of symbols in the word.
- Word::getConfidence() — Method in class Word
- Confidence of the OCR results for the word. Range [0, 1].
- AuditData::getPolicyDelta() — Method in class AuditData
- Policy delta between the original policy and the newly set policy.
- CancelOperationRequest::getName() — Method in class CancelOperationRequest
- The name of the operation resource to be cancelled.
- DeleteOperationRequest::getName() — Method in class DeleteOperationRequest
- The name of the operation resource to be deleted.
- GetOperationRequest — Class in namespace Google\LongRunning
- The request message for [Operations.GetOperation][google.longrunning.Operations.GetOperation].
- GetOperationRequest::getName() — Method in class GetOperationRequest
- The name of the operation resource.
- ListOperationsRequest::getName() — Method in class ListOperationsRequest
- The name of the operation collection.
- ListOperationsRequest::getFilter() — Method in class ListOperationsRequest
- The standard list filter.
- ListOperationsRequest::getPageSize() — Method in class ListOperationsRequest
- The standard list page size.
- ListOperationsRequest::getPageToken() — Method in class ListOperationsRequest
- The standard list page token.
- ListOperationsResponse::getOperations() — Method in class ListOperationsResponse
- A list of operations that matches the specified filter in the request.
- ListOperationsResponse::getNextPageToken() — Method in class ListOperationsResponse
- The standard List next-page token.
- Operation::getName() — Method in class Operation
- The server-assigned name, which is only unique within the same service that
originally returns it. If you use the default HTTP mapping, the
nameshould have the format ofoperations/some/unique/name. - Operation::getMetadata() — Method in class Operation
- Service-specific metadata associated with the operation. It typically contains progress information and common metadata such as create time.
- Operation::getDone() — Method in class Operation
- If the value is
false, it means the operation is still in progress. - Operation::getError() — Method in class Operation
- The error result of the operation in case of failure or cancellation.
- Operation::getResponse() — Method in class Operation
- The normal response of the operation in case of success. If the original
method returns no data on success, such as
Delete, the response isgoogle.protobuf.Empty. If the original method is standardGet/Create/Update, the response should be the resource. For other methods, the response should have the typeXxxResponse, whereXxxis the original method name. For example, if the original method name isTakeSnapshot(), the inferred response type isTakeSnapshotResponse. - Operation::getResult() — Method in class Operation
- OperationsGrpcClient::GetOperation() — Method in class OperationsGrpcClient
- Gets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service.
- BadRequest::getFieldViolations() — Method in class BadRequest
- Describes all violations in a client request.
- BadRequest_FieldViolation::getField() — Method in class BadRequest_FieldViolation
- A path leading to a field in the request body. The value will be a sequence of dot-separated identifiers that identify a protocol buffer field. E.g., "field_violations.field" would identify this field.
- BadRequest_FieldViolation::getDescription() — Method in class BadRequest_FieldViolation
- A description of why the request element is bad.
- DebugInfo::getStackEntries() — Method in class DebugInfo
- The stack trace entries indicating where the error occurred.
- DebugInfo::getDetail() — Method in class DebugInfo
- Additional debugging information provided by the server.
- Help::getLinks() — Method in class Help
- URL(s) pointing to additional information on handling the current error.
- Help_Link::getDescription() — Method in class Help_Link
- Describes what the link offers.
- Help_Link::getUrl() — Method in class Help_Link
- The URL of the link.
- LocalizedMessage::getLocale() — Method in class LocalizedMessage
- The locale used following the specification defined at http://www.rfc-editor.org/rfc/bcp/bcp47.txt.
- LocalizedMessage::getMessage() — Method in class LocalizedMessage
- The localized error message in the above locale.
- PreconditionFailure::getViolations() — Method in class PreconditionFailure
- Describes all precondition violations.
- PreconditionFailure_Violation::getType() — Method in class PreconditionFailure_Violation
- The type of PreconditionFailure. We recommend using a service-specific enum type to define the supported precondition violation types. For example, "TOS" for "Terms of Service violation".
- PreconditionFailure_Violation::getSubject() — Method in class PreconditionFailure_Violation
- The subject, relative to the type, that failed.
- PreconditionFailure_Violation::getDescription() — Method in class PreconditionFailure_Violation
- A description of how the precondition failed. Developers can use this description to understand how to fix the failure.
- QuotaFailure::getViolations() — Method in class QuotaFailure
- Describes all quota violations.
- QuotaFailure_Violation::getSubject() — Method in class QuotaFailure_Violation
- The subject on which the quota check failed.
- QuotaFailure_Violation::getDescription() — Method in class QuotaFailure_Violation
- A description of how the quota check failed. Clients can use this description to find more about the quota configuration in the service's public documentation, or find the relevant quota limit to adjust through developer console.
- RequestInfo::getRequestId() — Method in class RequestInfo
- An opaque string that should only be interpreted by the service generating it. For example, it can be used to identify requests in the service's logs.
- RequestInfo::getServingData() — Method in class RequestInfo
- Any data that was used to serve this request. For example, an encrypted stack trace that can be sent back to the service provider for debugging.
- ResourceInfo::getResourceType() — Method in class ResourceInfo
- A name for the type of resource being accessed, e.g. "sql table", "cloud storage bucket", "file", "Google calendar"; or the type URL of the resource: e.g. "type.googleapis.com/google.pubsub.v1.Topic".
- ResourceInfo::getResourceName() — Method in class ResourceInfo
- The name of the resource being accessed. For example, a shared calendar name: "example.com_4fghdhgsrgh@group.calendar.google.com", if the current error is [google.rpc.Code.PERMISSION_DENIED][google.rpc.Code.PERMISSION_DENIED].
- ResourceInfo::getOwner() — Method in class ResourceInfo
- The owner of the resource (optional).
- ResourceInfo::getDescription() — Method in class ResourceInfo
- Describes what error is encountered when accessing this resource.
- RetryInfo::getRetryDelay() — Method in class RetryInfo
- Clients should wait at least this long between retrying the same request.
- Status::getCode() — Method in class Status
- The status code, which should be an enum value of [google.rpc.Code][google.rpc.Code].
- Status::getMessage() — Method in class Status
- A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the [google.rpc.Status.details][google.rpc.Status.details] field, or localized by the client.
- Status::getDetails() — Method in class Status
- A list of messages that carry the error details. There is a common set of message types for APIs to use.
- Color::getRed() — Method in class Color
- The amount of red in the color as a value in the interval [0, 1].
- Color::getGreen() — Method in class Color
- The amount of green in the color as a value in the interval [0, 1].
- Color::getBlue() — Method in class Color
- The amount of blue in the color as a value in the interval [0, 1].
- Color::getAlpha() — Method in class Color
- The fraction of this color that should be applied to the pixel. That is, the final pixel color is defined by the equation: pixel color = alpha * (this color) + (1.0 - alpha) * (background color) This means that a value of 1.0 corresponds to a solid color, whereas a value of 0.0 corresponds to a completely transparent color. This uses a wrapper message rather than a simple float scalar so that it is possible to distinguish between a default value and the value being unset.
- Date::getYear() — Method in class Date
- Year of date. Must be from 1 to 9999, or 0 if specifying a date without a year.
- Date::getMonth() — Method in class Date
- Month of year. Must be from 1 to 12.
- Date::getDay() — Method in class Date
- Day of month. Must be from 1 to 31 and valid for the year and month, or 0 if specifying a year/month where the day is not significant.
- LatLng::getLatitude() — Method in class LatLng
- The latitude in degrees. It must be in the range [-90.0, +90.0].
- LatLng::getLongitude() — Method in class LatLng
- The longitude in degrees. It must be in the range [-180.0, +180.0].
- Money::getCurrencyCode() — Method in class Money
- The 3-letter currency code defined in ISO 4217.
- Money::getUnits() — Method in class Money
- The whole units of the amount.
- Money::getNanos() — Method in class Money
- Number of nano (10^-9) units of the amount.
- PostalAddress::getRevision() — Method in class PostalAddress
- The schema revision of the
PostalAddress. - PostalAddress::getRegionCode() — Method in class PostalAddress
- Required. CLDR region code of the country/region of the address. This is never inferred and it is up to the user to ensure the value is correct. See http://cldr.unicode.org/ and http://www.unicode.org/cldr/charts/30/supplemental/territory_information.html for details. Example: "CH" for Switzerland.
- PostalAddress::getLanguageCode() — Method in class PostalAddress
- Optional. BCP-47 language code of the contents of this address (if known). This is often the UI language of the input form or is expected to match one of the languages used in the address' country/region, or their transliterated equivalents.
- PostalAddress::getPostalCode() — Method in class PostalAddress
- Optional. Postal code of the address. Not all countries use or require postal codes to be present, but where they are used, they may trigger additional validation with other parts of the address (e.g. state/zip validation in the U.S.A.).
- PostalAddress::getSortingCode() — Method in class PostalAddress
- Optional. Additional, country-specific, sorting code. This is not used in most regions. Where it is used, the value is either a string like "CEDEX", optionally followed by a number (e.g. "CEDEX 7"), or just a number alone, representing the "sector code" (Jamaica), "delivery area indicator" (Malawi) or "post office indicator" (e.g. Côte d'Ivoire).
- PostalAddress::getAdministrativeArea() — Method in class PostalAddress
- Optional. Highest administrative subdivision which is used for postal addresses of a country or region.
- PostalAddress::getLocality() — Method in class PostalAddress
- Optional. Generally refers to the city/town portion of the address.
- PostalAddress::getSublocality() — Method in class PostalAddress
- Optional. Sublocality of the address.
- PostalAddress::getAddressLines() — Method in class PostalAddress
- Unstructured address lines describing the lower levels of an address.
- PostalAddress::getRecipients() — Method in class PostalAddress
- Optional. The recipient at the address.
- PostalAddress::getOrganization() — Method in class PostalAddress
- Optional. The name of the organization at the address.
- TimeOfDay::getHours() — Method in class TimeOfDay
- Hours of day in 24 hour format. Should be from 0 to 23. An API may choose to allow the value "24:00:00" for scenarios like business closing time.
- TimeOfDay::getMinutes() — Method in class TimeOfDay
- Minutes of hour of day. Must be from 0 to 59.
- TimeOfDay::getSeconds() — Method in class TimeOfDay
- Seconds of minutes of the time. Must normally be from 0 to 59. An API may allow the value 60 if it allows leap-seconds.
- TimeOfDay::getNanos() — Method in class TimeOfDay
- Fractions of seconds in nanoseconds. Must be from 0 to 999,999,999.
H
- FixedSizeCollection::hasNextCollection() — Method in class FixedSizeCollection
- Returns true if there are more elements that can be retrieved from the API.
- Page::hasNextPage() — Method in class Page
- Returns true if there are more pages that can be retrieved from the API.
- Http — Class in namespace Google\Api
- Defines the HTTP configuration for a service. It contains a list of [HttpRule][google.api.HttpRule], each specifying the mapping of an RPC method to one or more HTTP REST API methods.
- HttpBody — Class in namespace Google\Api
- Message that represents an arbitrary HTTP body. It should only be used for payload formats that can't be represented as JSON, such as raw binary or an HTML page.
- HttpRule — Class in namespace Google\Api
HttpRuledefines the mapping of an RPC method to one or more HTTP REST APIs. The mapping determines what portions of the request message are populated from the path, query parameters, or body of the HTTP request. The mapping is typically specified as angoogle.api.httpannotation, see "google/api/annotations.proto" for details.- HorizontalPodAutoscaling — Class in namespace Google\Cloud\Container\V1
- Configuration options for the horizontal pod autoscaling feature, which increases or decreases the number of replica pods a replication controller has based on the resource usage of the existing pods.
- HttpLoadBalancing — Class in namespace Google\Cloud\Container\V1
- Configuration options for the HTTP (L7) load balancing controller addon, which makes it easy to set up HTTP load balancers for services in a cluster.
- HadoopJob — Class in namespace Google\Cloud\Dataproc\V1
- A Cloud Dataproc job for running Apache Hadoop MapReduce jobs on Apache Hadoop YARN.
- HiveJob — Class in namespace Google\Cloud\Dataproc\V1
- A Cloud Dataproc job for running Apache Hive queries on YARN.
- HttpRequestContext — Class in namespace Google\Cloud\ErrorReporting\V1beta1
- HTTP request data that is related to a reported error.
- HttpConfig — Class in namespace Google\Cloud\Iot\V1
- The configuration of the HTTP bridge for a device registry.
- HttpState — Class in namespace Google\Cloud\Iot\V1
- Indicates whether DeviceService (HTTP) is enabled or disabled for the registry. See the field description for details.
- HttpRequest — Class in namespace Google\Cloud\Logging\Type
- A common proto for logging HTTP requests. Only contains semantics defined by the HTTP specification. Product-specific logging information MUST be defined in a separate message.
- HttpMethod — Class in namespace Google\Cloud\Tasks\V2beta2
- The HTTP method used to execute the task.
- Help — Class in namespace Google\Rpc
- Provides links to documentation or for performing an out of band action.
- Help_Link — Class in namespace Google\Rpc
- Describes a URL link.
I
- ApiStatus::isValidStatus() — Method in class ApiStatus
- FixedSizeCollection::iterateCollections() — Method in class FixedSizeCollection
- Returns an iterator over FixedSizeCollections, starting with this and making API calls as required until all of the elements have been retrieved.
- $LexerConditions#inclusive — Property in class LexerConditions
- $Parser#input — Property in class Parser
- Parser::input() — Method in class Parser
- $ParserState#index — Property in class ParserState
- $ParserSymbol#index — Property in class ParserSymbol
- Segment::incrementBindingCount() — Method in class Segment
- Segment::incrementSegmentCount() — Method in class Segment
- OperationResponse::isDone() — Method in class OperationResponse
- Check whether the operation has completed.
- Page::iteratePages() — Method in class Page
- Return an iterator over Page objects, beginning with this object.
- PagedListResponse::iterateAllElements() — Method in class PagedListResponse
- Returns an iterator over the full list of elements. Elements of the list are retrieved lazily using the underlying API.
- PagedListResponse::iteratePages() — Method in class PagedListResponse
- Returns an iterator over pages of results. The pages are retrieved lazily from the underlying API.
- PagedListResponse::iterateFixedSizeCollections() — Method in class PagedListResponse
- Returns an iterator over fixed size collections of results.
- MockStubTrait::isExhausted() — Method in class MockStubTrait
- Instance — Class in namespace Google\Cloud\Bigtable\Admin\V2
- A collection of Bigtable [Tables][google.bigtable.admin.v2.Table] and the resources that serve them.
- Instance_State — Class in namespace Google\Cloud\Bigtable\Admin\V2
- Possible states of an instance.
- Instance_Type — Class in namespace Google\Cloud\Bigtable\Admin\V2
- The type of the instance.
- IPAllocationPolicy — Class in namespace Google\Cloud\Container\V1
- Configuration for controlling how IPs are allocated in the cluster.
- InstanceGroupConfig — Class in namespace Google\Cloud\Dataproc\V1
- Optional. The config settings for Google Compute Engine resources in an instance group, such as a master or worker group.
- $RepoId#id — Property in class RepoId
- AgentsGrpcClient::ImportAgent() — Method in class AgentsGrpcClient
- Imports the specified agent from a ZIP file.
- $BatchUpdateIntentsRequest#intent_batch — Property in class BatchUpdateIntentsRequest
- ImportAgentRequest — Class in namespace Google\Cloud\Dialogflow\V2
- The request message for [Agents.ImportAgent][google.cloud.dialogflow.v2.Agents.ImportAgent].
- InputAudioConfig — Class in namespace Google\Cloud\Dialogflow\V2
- Instructs the speech recognizer how to process the audio content.
- Intent — Class in namespace Google\Cloud\Dialogflow\V2
- Represents an intent.
- IntentBatch — Class in namespace Google\Cloud\Dialogflow\V2
- This message is a wrapper around a collection of intents.
- IntentView — Class in namespace Google\Cloud\Dialogflow\V2
- Represents the options for views of an intent.
- Intent_FollowupIntentInfo — Class in namespace Google\Cloud\Dialogflow\V2
- Represents a single followup intent in the chain.
- Intent_Message — Class in namespace Google\Cloud\Dialogflow\V2
- Corresponds to the
Responsefield in the Dialogflow console. - Intent_Message_BasicCard — Class in namespace Google\Cloud\Dialogflow\V2
- The basic card message. Useful for displaying information.
- Intent_Message_BasicCard_Button — Class in namespace Google\Cloud\Dialogflow\V2
- The button object that appears at the bottom of a card.
- Intent_Message_BasicCard_Button_OpenUriAction — Class in namespace Google\Cloud\Dialogflow\V2
- Opens the given URI.
- Intent_Message_Card — Class in namespace Google\Cloud\Dialogflow\V2
- The card response message.
- Intent_Message_Card_Button — Class in namespace Google\Cloud\Dialogflow\V2
- Optional. Contains information about a button.
- Intent_Message_CarouselSelect — Class in namespace Google\Cloud\Dialogflow\V2
- The card for presenting a carousel of options to select from.
- Intent_Message_CarouselSelect_Item — Class in namespace Google\Cloud\Dialogflow\V2
- An item in the carousel.
- Intent_Message_Image — Class in namespace Google\Cloud\Dialogflow\V2
- The image response message.
- Intent_Message_LinkOutSuggestion — Class in namespace Google\Cloud\Dialogflow\V2
- The suggestion chip message that allows the user to jump out to the app or website associated with this agent.
- Intent_Message_ListSelect — Class in namespace Google\Cloud\Dialogflow\V2
- The card for presenting a list of options to select from.
- Intent_Message_ListSelect_Item — Class in namespace Google\Cloud\Dialogflow\V2
- An item in the list.
- Intent_Message_Platform — Class in namespace Google\Cloud\Dialogflow\V2
- Represents different platforms that a rich message can be intended for.
- Intent_Message_QuickReplies — Class in namespace Google\Cloud\Dialogflow\V2
- The quick replies response message.
- Intent_Message_SelectItemInfo — Class in namespace Google\Cloud\Dialogflow\V2
- Additional info about the select item for when it is triggered in a dialog.
- Intent_Message_SimpleResponse — Class in namespace Google\Cloud\Dialogflow\V2
- The simple response message containing speech or text.
- Intent_Message_SimpleResponses — Class in namespace Google\Cloud\Dialogflow\V2
- The collection of simple response candidates.
- Intent_Message_Suggestion — Class in namespace Google\Cloud\Dialogflow\V2
- The suggestion chip message that the user can tap to quickly post a reply to the conversation.
- Intent_Message_Suggestions — Class in namespace Google\Cloud\Dialogflow\V2
- The collection of suggestions.
- Intent_Message_Text — Class in namespace Google\Cloud\Dialogflow\V2
- The text response message.
- Intent_Parameter — Class in namespace Google\Cloud\Dialogflow\V2
- Represents intent parameters.
- Intent_TrainingPhrase — Class in namespace Google\Cloud\Dialogflow\V2
- Represents an example or template that the agent is trained on.
- Intent_TrainingPhrase_Part — Class in namespace Google\Cloud\Dialogflow\V2
- Represents a part of a training phrase.
- Intent_TrainingPhrase_Type — Class in namespace Google\Cloud\Dialogflow\V2
- Represents different types of training phrases.
- Intent_WebhookState — Class in namespace Google\Cloud\Dialogflow\V2
- Represents the different states that webhooks can be in.
- IntentsGrpcClient — Class in namespace Google\Cloud\Dialogflow\V2
- An intent represents a mapping between input from a user and an action to
be taken by your application. When you pass user input to the
[DetectIntent][google.cloud.dialogflow.v2.Sessions.DetectIntent] (or
[StreamingDetectIntent][google.cloud.dialogflow.v2.Sessions.StreamingDetectIntent]) method, the
Dialogflow API analyzes the input and searches
for a matching intent. If no match is found, the Dialogflow API returns a
fallback intent (
is_fallback= true). - $QueryInput#input — Property in class QueryInput
- DlpServiceGrpcClient::InspectContent() — Method in class DlpServiceGrpcClient
- Finds potentially sensitive info in content.
- ImageLocation — Class in namespace Google\Cloud\Dlp\V2
- Location of the finding within an image.
- InfoType — Class in namespace Google\Cloud\Dlp\V2
- Type of information detected by the API.
- InfoTypeDescription — Class in namespace Google\Cloud\Dlp\V2
- InfoType description.
- InfoTypeStats — Class in namespace Google\Cloud\Dlp\V2
- Statistics regarding a specific InfoType.
- InfoTypeSupportedBy — Class in namespace Google\Cloud\Dlp\V2
- Parts of the APIs which use certain infoTypes.
- InfoTypeTransformations — Class in namespace Google\Cloud\Dlp\V2
- A type of transformation that will scan unstructured text and
apply various
PrimitiveTransformations to each finding, where the transformation is applied to only values that were identified as a specific info_type. - InfoTypeTransformations_InfoTypeTransformation — Class in namespace Google\Cloud\Dlp\V2
- A transformation to apply to text that is identified as a specific info_type.
- InspectConfig — Class in namespace Google\Cloud\Dlp\V2
- Configuration description of the scanning process.
- InspectConfig_FindingLimits — Class in namespace Google\Cloud\Dlp\V2
- Generated from protobuf message
google.privacy.dlp.v2.InspectConfig.FindingLimits - InspectConfig_FindingLimits_InfoTypeLimit — Class in namespace Google\Cloud\Dlp\V2
- Max findings configuration per infoType, per content item or long running DlpJob.
- InspectContentRequest — Class in namespace Google\Cloud\Dlp\V2
- Request to search for potentially sensitive info in a ContentItem.
- InspectContentResponse — Class in namespace Google\Cloud\Dlp\V2
- Results of inspecting an item.
- InspectDataSourceDetails — Class in namespace Google\Cloud\Dlp\V2
- The results of an inspect DataSource job.
- InspectDataSourceDetails_RequestedOptions — Class in namespace Google\Cloud\Dlp\V2
- Generated from protobuf message
google.privacy.dlp.v2.InspectDataSourceDetails.RequestedOptions - InspectDataSourceDetails_Result — Class in namespace Google\Cloud\Dlp\V2
- Generated from protobuf message
google.privacy.dlp.v2.InspectDataSourceDetails.Result - InspectJobConfig — Class in namespace Google\Cloud\Dlp\V2
- Generated from protobuf message
google.privacy.dlp.v2.InspectJobConfig - InspectResult — Class in namespace Google\Cloud\Dlp\V2
- All the findings for a single scanned item.
- InspectTemplate — Class in namespace Google\Cloud\Dlp\V2
- The inspectTemplate contains a configuration (set of types of sensitive data to be detected) to be used anywhere you otherwise would normally specify InspectConfig.
- $Key_PathElement#id_type — Property in class Key_PathElement
- IAMPolicyGrpcClient — Class in namespace Google\Cloud\Iam\V1
API Overview
- ImportSshPublicKeyRequest — Class in namespace Google\Cloud\OsLogin\V1beta
- A request message for importing an SSH public key.
- ImportSshPublicKeyResponse — Class in namespace Google\Cloud\OsLogin\V1beta
- A response message for importing an SSH public key.
- OsLoginServiceGrpcClient::ImportSshPublicKey() — Method in class OsLoginServiceGrpcClient
- Adds an SSH public key and returns the profile information. Default POSIX account information is set when no username and UID exist as part of the login profile.
- Instance — Class in namespace Google\Cloud\Redis\V1beta1
- A Google Cloud Redis instance.
- Instance_State — Class in namespace Google\Cloud\Redis\V1beta1
- Represents the different states of a Redis instance.
- Instance_Tier — Class in namespace Google\Cloud\Redis\V1beta1
- Available service tiers to choose from
- Instance — Class in namespace Google\Cloud\Spanner\Admin\Instance\V1
- An isolated set of Cloud Spanner resources on which databases can be hosted.
- InstanceAdminGrpcClient — Class in namespace Google\Cloud\Spanner\Admin\Instance\V1
- Cloud Spanner Instance Admin API
- InstanceConfig — Class in namespace Google\Cloud\Spanner\Admin\Instance\V1
- A possible configuration for a Cloud Spanner instance. Configurations define the geographic placement of nodes and their replication.
- Instance_State — Class in namespace Google\Cloud\Spanner\Admin\Instance\V1
- Indicates the current state of the instance.
- Image — Class in namespace Google\Cloud\Vision\V1
- Client image to perform Google Cloud Vision API tasks over.
- ImageAnnotationContext — Class in namespace Google\Cloud\Vision\V1
- If an image was produced from a file (e.g. a PDF), this message gives information about the source of that image.
- ImageAnnotatorGrpcClient — Class in namespace Google\Cloud\Vision\V1
- Service that performs Google Cloud Vision API detection tasks over client images, such as face, landmark, logo, label, and text detection. The ImageAnnotator service returns detected entities from the images.
- ImageContext — Class in namespace Google\Cloud\Vision\V1
- Image context and/or feature-specific parameters.
- ImageProperties — Class in namespace Google\Cloud\Vision\V1
- Stores image properties, such as dominant colors.
- ImageSource — Class in namespace Google\Cloud\Vision\V1
- External image source (Google Cloud Storage or web URL image location).
- InputConfig — Class in namespace Google\Cloud\Vision\V1
- The desired input location and metadata.
J
- Job — Class in namespace Google\Cloud\Dataproc\V1
- A Cloud Dataproc job resource.
- JobControllerGrpcClient — Class in namespace Google\Cloud\Dataproc\V1
- The JobController provides methods to manage jobs.
- JobPlacement — Class in namespace Google\Cloud\Dataproc\V1
- Cloud Dataproc job config.
- JobReference — Class in namespace Google\Cloud\Dataproc\V1
- Encapsulates the full scoping used to reference a job.
- JobScheduling — Class in namespace Google\Cloud\Dataproc\V1
- Job scheduling options.
- JobStatus — Class in namespace Google\Cloud\Dataproc\V1
- Cloud Dataproc job status.
- JobStatus_State — Class in namespace Google\Cloud\Dataproc\V1
- The job state.
- JobStatus_Substate — Class in namespace Google\Cloud\Dataproc\V1
- Protobuf enum
Google\Cloud\Dataproc\V1\JobStatus\Substate - $CreateDlpJobRequest#job — Property in class CreateDlpJobRequest
- JobTrigger — Class in namespace Google\Cloud\Dlp\V2
- Contains a configuration to make dlp api calls on a repeating basis.
- $JobTrigger#job — Property in class JobTrigger
- JobTrigger_Status — Class in namespace Google\Cloud\Dlp\V2
- Whether the trigger is currently active. If PAUSED or CANCELLED, no jobs will be created with this configuration. The service may automatically pause triggers experiencing frequent errors. To restart a job, set the status to HEALTHY after correcting user errors.
- JobTrigger_Trigger — Class in namespace Google\Cloud\Dlp\V2
- What event needs to occur for a new job to be started.
K
- $Segment#kind — Property in class Segment
- KubernetesDashboard — Class in namespace Google\Cloud\Container\V1
- Configuration for the Kubernetes Dashboard.
- Key — Class in namespace Google\Cloud\Dlp\V2
- A unique identifier for a Datastore entity.
- Key_PathElement — Class in namespace Google\Cloud\Dlp\V2
- A (kind, ID/name) pair used to construct a key path.
- KindExpression — Class in namespace Google\Cloud\Dlp\V2
- A representation of a Datastore kind.
- KmsWrappedCryptoKey — Class in namespace Google\Cloud\Dlp\V2
- Include to use an existing data crypto key wrapped by KMS.
- KeyRange — Class in namespace Google\Cloud\Spanner\V1
- KeyRange represents a range of rows in a table or index.
- KeySet — Class in namespace Google\Cloud\Spanner\V1
KeySetdefines a collection of Cloud Spanner keys and/or key ranges. All the keys are expected to be in the same table or index. The keys need not be sorted in any particular way.
L
- LexerConditions — Class in namespace Google\ApiCore\Jison
- LexerError — Class in namespace Google\ApiCore\Jison
- $LexerError#lineNo — Property in class LexerError
- $Parser#less — Property in class Parser
- Parser::lexerError() — Method in class Parser
- Parser::lexerLex() — Method in class Parser
- Parser::LexerPerformAction() — Method in class Parser
- $ParserError#lineNo — Property in class ParserError
- $ParserError#loc — Property in class ParserError
- $ParserLocation#lastLine — Property in class ParserLocation
- $ParserLocation#lastColumn — Property in class ParserLocation
- $ParserProduction#len — Property in class ParserProduction
- $ParserValue#leng — Property in class ParserValue
- $ParserValue#loc — Property in class ParserValue
- $ParserValue#lineNo — Property in class ParserValue
- $Segment#literal — Property in class Segment
- OperationsGapicClient::listOperations() — Method in class OperationsGapicClient
- Lists operations that match the specified filter in the request. If the
server doesn't support this method, it returns
UNIMPLEMENTED. - RetrySettings::load() — Method in class RetrySettings
- Constructs an array mapping method names to CallSettings.
- LabelDescriptor — Class in namespace Google\Api
- A description of a label.
- LabelDescriptor_ValueType — Class in namespace Google\Api
- Value types that can be used as label values.
- LogDescriptor — Class in namespace Google\Api
- A description of a log type. Example in YAML format: - name: library.googleapis.com/activity_history description: The history of borrowing and returning library items.
- Logging — Class in namespace Google\Api
- Logging configuration of the service.
- Logging_LoggingDestination — Class in namespace Google\Api
- Configuration of a specific logging destination (the producer project or the consumer project).
- DataTransferServiceGrpcClient::ListDataSources() — Method in class DataTransferServiceGrpcClient
- Lists supported data sources and returns their settings, which can be used for UI rendering.
- DataTransferServiceGrpcClient::ListTransferConfigs() — Method in class DataTransferServiceGrpcClient
- Returns information about all data transfers in the project.
- DataTransferServiceGrpcClient::ListTransferRuns() — Method in class DataTransferServiceGrpcClient
- Returns information about running and completed jobs.
- DataTransferServiceGrpcClient::ListTransferLogs() — Method in class DataTransferServiceGrpcClient
- Returns user facing log messages for the data transfer run.
- ListDataSourcesRequest — Class in namespace Google\Cloud\BigQuery\DataTransfer\V1
- Request to list supported data sources and their data transfer settings.
- ListDataSourcesResponse — Class in namespace Google\Cloud\BigQuery\DataTransfer\V1
- Returns list of supported data sources and their metadata.
- ListTransferConfigsRequest — Class in namespace Google\Cloud\BigQuery\DataTransfer\V1
- A request to list data transfers configured for a BigQuery project.
- ListTransferConfigsResponse — Class in namespace Google\Cloud\BigQuery\DataTransfer\V1
- The returned list of pipelines in the project.
- ListTransferLogsRequest — Class in namespace Google\Cloud\BigQuery\DataTransfer\V1
- A request to get user facing log messages associated with data transfer run.
- ListTransferLogsResponse — Class in namespace Google\Cloud\BigQuery\DataTransfer\V1
- The returned list transfer run messages.
- ListTransferRunsRequest — Class in namespace Google\Cloud\BigQuery\DataTransfer\V1
- A request to list data transfer runs. UI can use this method to show/filter specific data transfer runs. The data source can use this method to request all scheduled transfer runs.
- ListTransferRunsRequest_RunAttempt — Class in namespace Google\Cloud\BigQuery\DataTransfer\V1
- Represents which runs should be pulled.
- ListTransferRunsResponse — Class in namespace Google\Cloud\BigQuery\DataTransfer\V1
- The returned list of pipelines in the project.
- BigtableInstanceAdminGrpcClient::ListInstances() — Method in class BigtableInstanceAdminGrpcClient
- Lists information about instances in a project.
- BigtableInstanceAdminGrpcClient::ListClusters() — Method in class BigtableInstanceAdminGrpcClient
- Lists information about clusters in an instance.
- BigtableInstanceAdminGrpcClient::ListAppProfiles() — Method in class BigtableInstanceAdminGrpcClient
- Lists information about app profiles in an instance.
- BigtableTableAdminGrpcClient::ListTables() — Method in class BigtableTableAdminGrpcClient
- Lists all tables served from a specified instance.
- BigtableTableAdminGrpcClient::ListSnapshots() — Method in class BigtableTableAdminGrpcClient
- Lists all snapshots associated with the specified cluster.
- ListAppProfilesRequest — Class in namespace Google\Cloud\Bigtable\Admin\V2
- Request message for BigtableInstanceAdmin.ListAppProfiles.
- ListAppProfilesResponse — Class in namespace Google\Cloud\Bigtable\Admin\V2
- Response message for BigtableInstanceAdmin.ListAppProfiles.
- ListClustersRequest — Class in namespace Google\Cloud\Bigtable\Admin\V2
- Request message for BigtableInstanceAdmin.ListClusters.
- ListClustersResponse — Class in namespace Google\Cloud\Bigtable\Admin\V2
- Response message for BigtableInstanceAdmin.ListClusters.
- ListInstancesRequest — Class in namespace Google\Cloud\Bigtable\Admin\V2
- Request message for BigtableInstanceAdmin.ListInstances.
- ListInstancesResponse — Class in namespace Google\Cloud\Bigtable\Admin\V2
- Response message for BigtableInstanceAdmin.ListInstances.
- ListSnapshotsRequest — Class in namespace Google\Cloud\Bigtable\Admin\V2
- Request message for [google.bigtable.admin.v2.BigtableTableAdmin.ListSnapshots][google.bigtable.admin.v2.BigtableTableAdmin.ListSnapshots] Note: This is a private alpha release of Cloud Bigtable snapshots. This feature is not currently available to most Cloud Bigtable customers. This feature might be changed in backward-incompatible ways and is not recommended for production use. It is not subject to any SLA or deprecation policy.
- ListSnapshotsResponse — Class in namespace Google\Cloud\Bigtable\Admin\V2
- Response message for [google.bigtable.admin.v2.BigtableTableAdmin.ListSnapshots][google.bigtable.admin.v2.BigtableTableAdmin.ListSnapshots] Note: This is a private alpha release of Cloud Bigtable snapshots. This feature is not currently available to most Cloud Bigtable customers. This feature might be changed in backward-incompatible ways and is not recommended for production use. It is not subject to any SLA or deprecation policy.
- ListTablesRequest — Class in namespace Google\Cloud\Bigtable\Admin\V2
- Request message for [google.bigtable.admin.v2.BigtableTableAdmin.ListTables][google.bigtable.admin.v2.BigtableTableAdmin.ListTables]
- ListTablesResponse — Class in namespace Google\Cloud\Bigtable\Admin\V2
- Response message for [google.bigtable.admin.v2.BigtableTableAdmin.ListTables][google.bigtable.admin.v2.BigtableTableAdmin.ListTables]
- ClusterManagerGrpcClient::ListClusters() — Method in class ClusterManagerGrpcClient
- Lists all clusters owned by a project in either the specified zone or all zones.
- ClusterManagerGrpcClient::ListOperations() — Method in class ClusterManagerGrpcClient
- Lists all operations in a project in a specific zone or all zones.
- ClusterManagerGrpcClient::ListNodePools() — Method in class ClusterManagerGrpcClient
- Lists the node pools for a cluster.
- LegacyAbac — Class in namespace Google\Cloud\Container\V1
- Configuration for the legacy Attribute Based Access Control authorization mode.
- ListClustersRequest — Class in namespace Google\Cloud\Container\V1
- ListClustersRequest lists clusters.
- ListClustersResponse — Class in namespace Google\Cloud\Container\V1
- ListClustersResponse is the result of ListClustersRequest.
- ListNodePoolsRequest — Class in namespace Google\Cloud\Container\V1
- ListNodePoolsRequest lists the node pool(s) for a cluster.
- ListNodePoolsResponse — Class in namespace Google\Cloud\Container\V1
- ListNodePoolsResponse is the result of ListNodePoolsRequest.
- ListOperationsRequest — Class in namespace Google\Cloud\Container\V1
- ListOperationsRequest lists operations.
- ListOperationsResponse — Class in namespace Google\Cloud\Container\V1
- ListOperationsResponse is the result of ListOperationsRequest.
- ClusterControllerGrpcClient::ListClusters() — Method in class ClusterControllerGrpcClient
- Lists all regions/{region}/clusters in a project.
- JobControllerGrpcClient::ListJobs() — Method in class JobControllerGrpcClient
- Lists regions/{region}/jobs in a project.
- ListClustersRequest — Class in namespace Google\Cloud\Dataproc\V1
- A request to list the clusters in a project.
- ListClustersResponse — Class in namespace Google\Cloud\Dataproc\V1
- The list of all clusters in a project.
- ListJobsRequest — Class in namespace Google\Cloud\Dataproc\V1
- A request to list jobs in a project.
- ListJobsRequest_JobStateMatcher — Class in namespace Google\Cloud\Dataproc\V1
- A matcher that specifies categories of job states.
- ListJobsResponse — Class in namespace Google\Cloud\Dataproc\V1
- A list of jobs in a project.
- LoggingConfig — Class in namespace Google\Cloud\Dataproc\V1
- The runtime logging config of the job.
- LoggingConfig_Level — Class in namespace Google\Cloud\Dataproc\V1
- The Log4j level for job execution. When running an Apache Hive job, Cloud Dataproc configures the Hive client to an equivalent verbosity level.
- Controller2GrpcClient::ListActiveBreakpoints() — Method in class Controller2GrpcClient
- Returns the list of all active breakpoints for the debuggee.
- Debugger2GrpcClient::ListBreakpoints() — Method in class Debugger2GrpcClient
- Lists all breakpoints for the debuggee.
- Debugger2GrpcClient::ListDebuggees() — Method in class Debugger2GrpcClient
- Lists all the debuggees that the user has access to.
- ListActiveBreakpointsRequest — Class in namespace Google\Cloud\Debugger\V2
- Request to list active breakpoints.
- ListActiveBreakpointsResponse — Class in namespace Google\Cloud\Debugger\V2
- Response for listing active breakpoints.
- ListBreakpointsRequest — Class in namespace Google\Cloud\Debugger\V2
- Request to list breakpoints.
- ListBreakpointsRequest_BreakpointActionValue — Class in namespace Google\Cloud\Debugger\V2
- Wrapper message for
Breakpoint.Action. Defines a filter on the action field of breakpoints. - ListBreakpointsResponse — Class in namespace Google\Cloud\Debugger\V2
- Response for listing breakpoints.
- ListDebuggeesRequest — Class in namespace Google\Cloud\Debugger\V2
- Request to list debuggees.
- ListDebuggeesResponse — Class in namespace Google\Cloud\Debugger\V2
- Response for listing debuggees.
- ContextsGrpcClient::ListContexts() — Method in class ContextsGrpcClient
- Returns the list of all contexts in the specified session.
- EntityTypesGrpcClient::ListEntityTypes() — Method in class EntityTypesGrpcClient
- Returns the list of all entity types in the specified agent.
- IntentsGrpcClient::ListIntents() — Method in class IntentsGrpcClient
- Returns the list of all intents in the specified agent.
- ListContextsRequest — Class in namespace Google\Cloud\Dialogflow\V2
- The request message for [Contexts.ListContexts][google.cloud.dialogflow.v2.Contexts.ListContexts].
- ListContextsResponse — Class in namespace Google\Cloud\Dialogflow\V2
- The response message for [Contexts.ListContexts][google.cloud.dialogflow.v2.Contexts.ListContexts].
- ListEntityTypesRequest — Class in namespace Google\Cloud\Dialogflow\V2
- The request message for [EntityTypes.ListEntityTypes][google.cloud.dialogflow.v2.EntityTypes.ListEntityTypes].
- ListEntityTypesResponse — Class in namespace Google\Cloud\Dialogflow\V2
- The response message for [EntityTypes.ListEntityTypes][google.cloud.dialogflow.v2.EntityTypes.ListEntityTypes].
- ListIntentsRequest — Class in namespace Google\Cloud\Dialogflow\V2
- The request message for [Intents.ListIntents][google.cloud.dialogflow.v2.Intents.ListIntents].
- ListIntentsResponse — Class in namespace Google\Cloud\Dialogflow\V2
- The response message for [Intents.ListIntents][google.cloud.dialogflow.v2.Intents.ListIntents].
- ListSessionEntityTypesRequest — Class in namespace Google\Cloud\Dialogflow\V2
- The request message for [SessionEntityTypes.ListSessionEntityTypes][google.cloud.dialogflow.v2.SessionEntityTypes.ListSessionEntityTypes].
- ListSessionEntityTypesResponse — Class in namespace Google\Cloud\Dialogflow\V2
- The response message for [SessionEntityTypes.ListSessionEntityTypes][google.cloud.dialogflow.v2.SessionEntityTypes.ListSessionEntityTypes].
- SessionEntityTypesGrpcClient::ListSessionEntityTypes() — Method in class SessionEntityTypesGrpcClient
- Returns the list of all session entity types in the specified session.
- $ContentLocation#location — Property in class ContentLocation
- DlpServiceGrpcClient::ListInfoTypes() — Method in class DlpServiceGrpcClient
- Returns a list of the sensitive information types that the DLP API supports. For more information, see Listing supported predefined infoTypes.
- DlpServiceGrpcClient::ListInspectTemplates() — Method in class DlpServiceGrpcClient
- Lists InspectTemplates.
- DlpServiceGrpcClient::ListDeidentifyTemplates() — Method in class DlpServiceGrpcClient
- Lists DeidentifyTemplates.
- DlpServiceGrpcClient::ListJobTriggers() — Method in class DlpServiceGrpcClient
- Lists job triggers.
- DlpServiceGrpcClient::ListDlpJobs() — Method in class DlpServiceGrpcClient
- Lists DlpJobs that match the specified filter in the request.
- Likelihood — Class in namespace Google\Cloud\Dlp\V2
- Categorization of results based on how likely they are to represent a match, based on the number of elements they contain which imply a match.
- ListDeidentifyTemplatesRequest — Class in namespace Google\Cloud\Dlp\V2
- Request message for ListDeidentifyTemplates.
- ListDeidentifyTemplatesResponse — Class in namespace Google\Cloud\Dlp\V2
- Response message for ListDeidentifyTemplates.
- ListDlpJobsRequest — Class in namespace Google\Cloud\Dlp\V2
- The request message for listing DLP jobs.
- ListDlpJobsResponse — Class in namespace Google\Cloud\Dlp\V2
- The response message for listing DLP jobs.
- ListInfoTypesRequest — Class in namespace Google\Cloud\Dlp\V2
- Request for the list of infoTypes.
- ListInfoTypesResponse — Class in namespace Google\Cloud\Dlp\V2
- Response to the ListInfoTypes request.
- ListInspectTemplatesRequest — Class in namespace Google\Cloud\Dlp\V2
- Request message for ListInspectTemplates.
- ListInspectTemplatesResponse — Class in namespace Google\Cloud\Dlp\V2
- Response message for ListInspectTemplates.
- ListJobTriggersRequest — Class in namespace Google\Cloud\Dlp\V2
- Request message for ListJobTriggers.
- ListJobTriggersResponse — Class in namespace Google\Cloud\Dlp\V2
- Response message for ListJobTriggers.
- Location — Class in namespace Google\Cloud\Dlp\V2
- Specifies the location of the finding.
- ErrorStatsServiceGrpcClient::ListGroupStats() — Method in class ErrorStatsServiceGrpcClient
- Lists the specified groups.
- ErrorStatsServiceGrpcClient::ListEvents() — Method in class ErrorStatsServiceGrpcClient
- Lists the specified events.
- ListEventsRequest — Class in namespace Google\Cloud\ErrorReporting\V1beta1
- Specifies a set of error events to return.
- ListEventsResponse — Class in namespace Google\Cloud\ErrorReporting\V1beta1
- Contains a set of requested error events.
- ListGroupStatsRequest — Class in namespace Google\Cloud\ErrorReporting\V1beta1
- Specifies a set of
ErrorGroupStatsto return. - ListGroupStatsResponse — Class in namespace Google\Cloud\ErrorReporting\V1beta1
- Contains a set of requested error group stats.
- FirestoreGrpcClient::ListDocuments() — Method in class FirestoreGrpcClient
- Lists documents.
- FirestoreGrpcClient::Listen() — Method in class FirestoreGrpcClient
- Listens to changes.
- FirestoreGrpcClient::ListCollectionIds() — Method in class FirestoreGrpcClient
- Lists all the collection IDs underneath a document.
- ListCollectionIdsRequest — Class in namespace Google\Cloud\Firestore\V1beta1
- The request for [Firestore.ListCollectionIds][google.firestore.v1beta1.Firestore.ListCollectionIds].
- ListCollectionIdsResponse — Class in namespace Google\Cloud\Firestore\V1beta1
- The response from [Firestore.ListCollectionIds][google.firestore.v1beta1.Firestore.ListCollectionIds].
- ListDocumentsRequest — Class in namespace Google\Cloud\Firestore\V1beta1
- The request for [Firestore.ListDocuments][google.firestore.v1beta1.Firestore.ListDocuments].
- ListDocumentsResponse — Class in namespace Google\Cloud\Firestore\V1beta1
- The response for [Firestore.ListDocuments][google.firestore.v1beta1.Firestore.ListDocuments].
- ListenRequest — Class in namespace Google\Cloud\Firestore\V1beta1
- A request for [Firestore.Listen][google.firestore.v1beta1.Firestore.Listen]
- ListenResponse — Class in namespace Google\Cloud\Firestore\V1beta1
- The response for [Firestore.Listen][google.firestore.v1beta1.Firestore.Listen].
- DeviceManagerGrpcClient::ListDeviceRegistries() — Method in class DeviceManagerGrpcClient
- Lists device registries.
- DeviceManagerGrpcClient::ListDevices() — Method in class DeviceManagerGrpcClient
- List devices in a device registry.
- DeviceManagerGrpcClient::ListDeviceConfigVersions() — Method in class DeviceManagerGrpcClient
- Lists the last few versions of the device configuration in descending order (i.e.: newest first).
- DeviceManagerGrpcClient::ListDeviceStates() — Method in class DeviceManagerGrpcClient
- Lists the last few versions of the device state in descending order (i.e.: newest first).
- ListDeviceConfigVersionsRequest — Class in namespace Google\Cloud\Iot\V1
- Request for
ListDeviceConfigVersions. - ListDeviceConfigVersionsResponse — Class in namespace Google\Cloud\Iot\V1
- Response for
ListDeviceConfigVersions. - ListDeviceRegistriesRequest — Class in namespace Google\Cloud\Iot\V1
- Request for
ListDeviceRegistries. - ListDeviceRegistriesResponse — Class in namespace Google\Cloud\Iot\V1
- Response for
ListDeviceRegistries. - ListDeviceStatesRequest — Class in namespace Google\Cloud\Iot\V1
- Request for
ListDeviceStates. - ListDeviceStatesResponse — Class in namespace Google\Cloud\Iot\V1
- Response for
ListDeviceStates. - ListDevicesRequest — Class in namespace Google\Cloud\Iot\V1
- Request for
ListDevices. - ListDevicesResponse — Class in namespace Google\Cloud\Iot\V1
- Response for
ListDevices. - LanguageServiceGrpcClient — Class in namespace Google\Cloud\Language\V1beta2
- Provides text analysis operations such as sentiment analysis and entity recognition.
- LogSeverity — Class in namespace Google\Cloud\Logging\Type
- The severity of the event described in a log entry, expressed as one of the standard severity levels listed below. For your reference, the levels are assigned the listed numeric values. The effect of using numeric values other than those listed is undefined.
- ConfigServiceV2GrpcClient::ListSinks() — Method in class ConfigServiceV2GrpcClient
- Lists sinks.
- ConfigServiceV2GrpcClient::ListExclusions() — Method in class ConfigServiceV2GrpcClient
- Lists all the exclusions in a parent resource.
- ListExclusionsRequest — Class in namespace Google\Cloud\Logging\V2
- The parameters to
ListExclusions. - ListExclusionsResponse — Class in namespace Google\Cloud\Logging\V2
- Result returned from
ListExclusions. - ListLogEntriesRequest — Class in namespace Google\Cloud\Logging\V2
- The parameters to
ListLogEntries. - ListLogEntriesResponse — Class in namespace Google\Cloud\Logging\V2
- Result returned from
ListLogEntries. - ListLogMetricsRequest — Class in namespace Google\Cloud\Logging\V2
- The parameters to ListLogMetrics.
- ListLogMetricsResponse — Class in namespace Google\Cloud\Logging\V2
- Result returned from ListLogMetrics.
- ListLogsRequest — Class in namespace Google\Cloud\Logging\V2
- The parameters to ListLogs.
- ListLogsResponse — Class in namespace Google\Cloud\Logging\V2
- Result returned from ListLogs.
- ListMonitoredResourceDescriptorsRequest — Class in namespace Google\Cloud\Logging\V2
- The parameters to ListMonitoredResourceDescriptors
- ListMonitoredResourceDescriptorsResponse — Class in namespace Google\Cloud\Logging\V2
- Result returned from ListMonitoredResourceDescriptors.
- ListSinksRequest — Class in namespace Google\Cloud\Logging\V2
- The parameters to
ListSinks. - ListSinksResponse — Class in namespace Google\Cloud\Logging\V2
- Result returned from
ListSinks. - LogEntry — Class in namespace Google\Cloud\Logging\V2
- An individual entry in a log.
- LogEntryOperation — Class in namespace Google\Cloud\Logging\V2
- Additional information about a potentially long-running operation with which a log entry is associated.
- LogEntrySourceLocation — Class in namespace Google\Cloud\Logging\V2
- Additional information about the source code location that produced the log entry.
- LogExclusion — Class in namespace Google\Cloud\Logging\V2
- Specifies a set of log entries that are not to be stored in Stackdriver Logging. If your project receives a large volume of logs, you might be able to use exclusions to reduce your chargeable logs. Exclusions are processed after log sinks, so you can export log entries before they are excluded.
- LogMetric — Class in namespace Google\Cloud\Logging\V2
- Describes a logs-based metric. The value of the metric is the number of log entries that match a logs filter in a given time interval.
- LogMetric_ApiVersion — Class in namespace Google\Cloud\Logging\V2
- Stackdriver Logging API version.
- LogSink — Class in namespace Google\Cloud\Logging\V2
- Describes a sink used to export log entries to one of the following destinations in any project: a Cloud Storage bucket, a BigQuery dataset, or a Cloud Pub/Sub topic. A logs filter controls which log entries are exported. The sink must be created within a project, organization, billing account, or folder.
- LogSink_VersionFormat — Class in namespace Google\Cloud\Logging\V2
- Available log entry formats. Log entries can be written to Stackdriver Logging in either format and can be exported in either format.
- LoggingServiceV2GrpcClient — Class in namespace Google\Cloud\Logging\V2
- Service for ingesting and querying logs.
- LoggingServiceV2GrpcClient::ListLogEntries() — Method in class LoggingServiceV2GrpcClient
- Lists log entries. Use this method to retrieve log entries from Stackdriver Logging. For ways to export log entries, see Exporting Logs.
- LoggingServiceV2GrpcClient::ListMonitoredResourceDescriptors() — Method in class LoggingServiceV2GrpcClient
- Lists the descriptors for monitored resource types used by Stackdriver Logging.
- LoggingServiceV2GrpcClient::ListLogs() — Method in class LoggingServiceV2GrpcClient
- Lists the logs in projects, organizations, folders, or billing accounts.
- MetricsServiceV2GrpcClient::ListLogMetrics() — Method in class MetricsServiceV2GrpcClient
- Lists logs-based metrics.
- AlertPolicyServiceGrpcClient::ListAlertPolicies() — Method in class AlertPolicyServiceGrpcClient
- Lists the existing alerting policies for the project.
- GroupServiceGrpcClient::ListGroups() — Method in class GroupServiceGrpcClient
- Lists the existing groups.
- GroupServiceGrpcClient::ListGroupMembers() — Method in class GroupServiceGrpcClient
- Lists the monitored resources that are members of a group.
- ListAlertPoliciesRequest — Class in namespace Google\Cloud\Monitoring\V3
- The protocol for the
ListAlertPoliciesrequest. - ListAlertPoliciesResponse — Class in namespace Google\Cloud\Monitoring\V3
- The protocol for the
ListAlertPoliciesresponse. - ListGroupMembersRequest — Class in namespace Google\Cloud\Monitoring\V3
- The
ListGroupMembersrequest. - ListGroupMembersResponse — Class in namespace Google\Cloud\Monitoring\V3
- The
ListGroupMembersresponse. - ListGroupsRequest — Class in namespace Google\Cloud\Monitoring\V3
- The
ListGrouprequest. - ListGroupsResponse — Class in namespace Google\Cloud\Monitoring\V3
- The
ListGroupsresponse. - ListMetricDescriptorsRequest — Class in namespace Google\Cloud\Monitoring\V3
- The
ListMetricDescriptorsrequest. - ListMetricDescriptorsResponse — Class in namespace Google\Cloud\Monitoring\V3
- The
ListMetricDescriptorsresponse. - ListMonitoredResourceDescriptorsRequest — Class in namespace Google\Cloud\Monitoring\V3
- The
ListMonitoredResourceDescriptorsrequest. - ListMonitoredResourceDescriptorsResponse — Class in namespace Google\Cloud\Monitoring\V3
- The
ListMonitoredResourcDescriptorsresponse. - ListNotificationChannelDescriptorsRequest — Class in namespace Google\Cloud\Monitoring\V3
- The
ListNotificationChannelDescriptorsrequest. - ListNotificationChannelDescriptorsResponse — Class in namespace Google\Cloud\Monitoring\V3
- The
ListNotificationChannelDescriptorsresponse. - ListNotificationChannelsRequest — Class in namespace Google\Cloud\Monitoring\V3
- The
ListNotificationChannelsrequest. - ListNotificationChannelsResponse — Class in namespace Google\Cloud\Monitoring\V3
- The
ListNotificationChannelsresponse. - ListTimeSeriesRequest — Class in namespace Google\Cloud\Monitoring\V3
- The
ListTimeSeriesrequest. - ListTimeSeriesRequest_TimeSeriesView — Class in namespace Google\Cloud\Monitoring\V3
- Controls which fields are returned by
ListTimeSeries. - ListTimeSeriesResponse — Class in namespace Google\Cloud\Monitoring\V3
- The
ListTimeSeriesresponse. - ListUptimeCheckConfigsRequest — Class in namespace Google\Cloud\Monitoring\V3
- The protocol for the
ListUptimeCheckConfigsrequest. - ListUptimeCheckConfigsResponse — Class in namespace Google\Cloud\Monitoring\V3
- The protocol for the
ListUptimeCheckConfigsresponse. - ListUptimeCheckIpsRequest — Class in namespace Google\Cloud\Monitoring\V3
- The protocol for the
ListUptimeCheckIpsrequest. - ListUptimeCheckIpsResponse — Class in namespace Google\Cloud\Monitoring\V3
- The protocol for the
ListUptimeCheckIpsresponse. - MetricServiceGrpcClient::ListMonitoredResourceDescriptors() — Method in class MetricServiceGrpcClient
- Lists monitored resource descriptors that match a filter. This method does not require a Stackdriver account.
- MetricServiceGrpcClient::ListMetricDescriptors() — Method in class MetricServiceGrpcClient
- Lists metric descriptors that match a filter. This method does not require a Stackdriver account.
- MetricServiceGrpcClient::ListTimeSeries() — Method in class MetricServiceGrpcClient
- Lists time series that match a filter. This method does not require a Stackdriver account.
- NotificationChannelServiceGrpcClient::ListNotificationChannelDescriptors() — Method in class NotificationChannelServiceGrpcClient
- Lists the descriptors for supported channel types. The use of descriptors makes it possible for new channel types to be dynamically added.
- NotificationChannelServiceGrpcClient::ListNotificationChannels() — Method in class NotificationChannelServiceGrpcClient
- Lists the notification channels that have been created for the project.
- UptimeCheckServiceGrpcClient::ListUptimeCheckConfigs() — Method in class UptimeCheckServiceGrpcClient
- Lists the existing valid uptime check configurations for the project, leaving out any invalid configurations.
- UptimeCheckServiceGrpcClient::ListUptimeCheckIps() — Method in class UptimeCheckServiceGrpcClient
- Returns the list of IPs that checkers run from
- LoginProfile — Class in namespace Google\Cloud\OsLogin\V1beta
- The user profile information used for logging in to a virtual machine on Google Compute Engine.
- ListSnapshotsRequest — Class in namespace Google\Cloud\PubSub\V1
- Request for the
ListSnapshotsmethod. - ListSnapshotsResponse — Class in namespace Google\Cloud\PubSub\V1
- Response for the
ListSnapshotsmethod. - ListSubscriptionsRequest — Class in namespace Google\Cloud\PubSub\V1
- Request for the
ListSubscriptionsmethod. - ListSubscriptionsResponse — Class in namespace Google\Cloud\PubSub\V1
- Response for the
ListSubscriptionsmethod. - ListTopicSubscriptionsRequest — Class in namespace Google\Cloud\PubSub\V1
- Request for the
ListTopicSubscriptionsmethod. - ListTopicSubscriptionsResponse — Class in namespace Google\Cloud\PubSub\V1
- Response for the
ListTopicSubscriptionsmethod. - ListTopicsRequest — Class in namespace Google\Cloud\PubSub\V1
- Request for the
ListTopicsmethod. - ListTopicsResponse — Class in namespace Google\Cloud\PubSub\V1
- Response for the
ListTopicsmethod. - PublisherGrpcClient::ListTopics() — Method in class PublisherGrpcClient
- Lists matching topics.
- PublisherGrpcClient::ListTopicSubscriptions() — Method in class PublisherGrpcClient
- Lists the name of the subscriptions for this topic.
- SubscriberGrpcClient::ListSubscriptions() — Method in class SubscriberGrpcClient
- Lists matching subscriptions.
- SubscriberGrpcClient::ListSnapshots() — Method in class SubscriberGrpcClient
- Lists the existing snapshots.
- CloudRedisGrpcClient::ListInstances() — Method in class CloudRedisGrpcClient
- Lists all Redis instances owned by a project in either the specified location (region) or all locations.
- ListInstancesRequest — Class in namespace Google\Cloud\Redis\V1beta1
- Request for [ListInstances][google.cloud.redis.v1beta1.CloudRedis.ListInstances].
- ListInstancesResponse — Class in namespace Google\Cloud\Redis\V1beta1
- Response for [ListInstances][google.cloud.redis.v1beta1.CloudRedis.ListInstances].
- LocationMetadata — Class in namespace Google\Cloud\Redis\V1beta1
- This location metadata represents additional configuration options for a
given location where a Redis instance may be created. All fields are output
only. It is returned as content of the
google.cloud.location.Location.metadatafield. - DatabaseAdminGrpcClient::ListDatabases() — Method in class DatabaseAdminGrpcClient
- Lists Cloud Spanner databases.
- ListDatabasesRequest — Class in namespace Google\Cloud\Spanner\Admin\Database\V1
- The request for [ListDatabases][google.spanner.admin.database.v1.DatabaseAdmin.ListDatabases].
- ListDatabasesResponse — Class in namespace Google\Cloud\Spanner\Admin\Database\V1
- The response for [ListDatabases][google.spanner.admin.database.v1.DatabaseAdmin.ListDatabases].
- InstanceAdminGrpcClient::ListInstanceConfigs() — Method in class InstanceAdminGrpcClient
- Lists the supported instance configurations for a given project.
- InstanceAdminGrpcClient::ListInstances() — Method in class InstanceAdminGrpcClient
- Lists all instances in the given project.
- ListInstanceConfigsRequest — Class in namespace Google\Cloud\Spanner\Admin\Instance\V1
- The request for [ListInstanceConfigs][google.spanner.admin.instance.v1.InstanceAdmin.ListInstanceConfigs].
- ListInstanceConfigsResponse — Class in namespace Google\Cloud\Spanner\Admin\Instance\V1
- The response for [ListInstanceConfigs][google.spanner.admin.instance.v1.InstanceAdmin.ListInstanceConfigs].
- ListInstancesRequest — Class in namespace Google\Cloud\Spanner\Admin\Instance\V1
- The request for [ListInstances][google.spanner.admin.instance.v1.InstanceAdmin.ListInstances].
- ListInstancesResponse — Class in namespace Google\Cloud\Spanner\Admin\Instance\V1
- The response for [ListInstances][google.spanner.admin.instance.v1.InstanceAdmin.ListInstances].
- ListSessionsRequest — Class in namespace Google\Cloud\Spanner\V1
- The request for [ListSessions][google.spanner.v1.Spanner.ListSessions].
- ListSessionsResponse — Class in namespace Google\Cloud\Spanner\V1
- The response for [ListSessions][google.spanner.v1.Spanner.ListSessions].
- SpannerGrpcClient::ListSessions() — Method in class SpannerGrpcClient
- Lists all sessions in a given database.
- LongRunningRecognizeMetadata — Class in namespace Google\Cloud\Speech\V1
- Describes the progress of a long-running
LongRunningRecognizecall. It is included in themetadatafield of theOperationreturned by theGetOperationcall of thegoogle::longrunning::Operationsservice. - LongRunningRecognizeRequest — Class in namespace Google\Cloud\Speech\V1
- The top-level message sent by the client for the
LongRunningRecognizemethod. - LongRunningRecognizeResponse — Class in namespace Google\Cloud\Speech\V1
- The only message returned to the client by the
LongRunningRecognizemethod. - SpeechGrpcClient::LongRunningRecognize() — Method in class SpeechGrpcClient
- Performs asynchronous speech recognition: receive results via the
google.longrunning.Operations interface. Returns either an
Operation.erroror anOperation.responsewhich contains aLongRunningRecognizeResponsemessage. - LongRunningRecognizeMetadata — Class in namespace Google\Cloud\Speech\V1p1beta1
- Describes the progress of a long-running
LongRunningRecognizecall. It is included in themetadatafield of theOperationreturned by theGetOperationcall of thegoogle::longrunning::Operationsservice. - LongRunningRecognizeRequest — Class in namespace Google\Cloud\Speech\V1p1beta1
- The top-level message sent by the client for the
LongRunningRecognizemethod. - LongRunningRecognizeResponse — Class in namespace Google\Cloud\Speech\V1p1beta1
- The only message returned to the client by the
LongRunningRecognizemethod. - SpeechGrpcClient::LongRunningRecognize() — Method in class SpeechGrpcClient
- Performs asynchronous speech recognition: receive results via the
google.longrunning.Operations interface. Returns either an
Operation.erroror anOperation.responsewhich contains aLongRunningRecognizeResponsemessage. - CloudTasksGrpcClient::ListQueues() — Method in class CloudTasksGrpcClient
- Lists queues.
- CloudTasksGrpcClient::ListTasks() — Method in class CloudTasksGrpcClient
- Lists the tasks in a queue.
- CloudTasksGrpcClient::LeaseTasks() — Method in class CloudTasksGrpcClient
- Leases tasks from a pull queue for [lease_duration][google.cloud.tasks.v2beta2.LeaseTasksRequest.lease_duration].
- LeaseTasksRequest — Class in namespace Google\Cloud\Tasks\V2beta2
- Request message for leasing tasks using [LeaseTasks][google.cloud.tasks.v2beta2.CloudTasks.LeaseTasks].
- LeaseTasksResponse — Class in namespace Google\Cloud\Tasks\V2beta2
- Response message for leasing tasks using [LeaseTasks][google.cloud.tasks.v2beta2.CloudTasks.LeaseTasks].
- ListQueuesRequest — Class in namespace Google\Cloud\Tasks\V2beta2
- Request message for [ListQueues][google.cloud.tasks.v2beta2.CloudTasks.ListQueues].
- ListQueuesResponse — Class in namespace Google\Cloud\Tasks\V2beta2
- Response message for [ListQueues][google.cloud.tasks.v2beta2.CloudTasks.ListQueues].
- ListTasksRequest — Class in namespace Google\Cloud\Tasks\V2beta2
- Request message for listing tasks using [ListTasks][google.cloud.tasks.v2beta2.CloudTasks.ListTasks].
- ListTasksResponse — Class in namespace Google\Cloud\Tasks\V2beta2
- Response message for listing tasks using [ListTasks][google.cloud.tasks.v2beta2.CloudTasks.ListTasks].
- LabelAnnotation — Class in namespace Google\Cloud\VideoIntelligence\V1
- Label annotation.
- LabelDetectionConfig — Class in namespace Google\Cloud\VideoIntelligence\V1
- Config for LABEL_DETECTION.
- LabelDetectionMode — Class in namespace Google\Cloud\VideoIntelligence\V1
- Label detection mode.
- LabelFrame — Class in namespace Google\Cloud\VideoIntelligence\V1
- Video frame level annotation results for label detection.
- LabelSegment — Class in namespace Google\Cloud\VideoIntelligence\V1
- Video segment level annotation results for label detection.
- Likelihood — Class in namespace Google\Cloud\VideoIntelligence\V1
- Bucketized representation of likelihood.
- LabelAnnotation — Class in namespace Google\Cloud\VideoIntelligence\V1beta1
- Label annotation.
- LabelDetectionMode — Class in namespace Google\Cloud\VideoIntelligence\V1beta1
- Label detection mode.
- LabelLevel — Class in namespace Google\Cloud\VideoIntelligence\V1beta1
- Label level (scope).
- LabelLocation — Class in namespace Google\Cloud\VideoIntelligence\V1beta1
- Label location.
- Likelihood — Class in namespace Google\Cloud\VideoIntelligence\V1beta1
- Bucketized representation of likelihood.
- LabelAnnotation — Class in namespace Google\Cloud\VideoIntelligence\V1beta2
- Label annotation.
- LabelDetectionConfig — Class in namespace Google\Cloud\VideoIntelligence\V1beta2
- Config for LABEL_DETECTION.
- LabelDetectionMode — Class in namespace Google\Cloud\VideoIntelligence\V1beta2
- Label detection mode.
- LabelFrame — Class in namespace Google\Cloud\VideoIntelligence\V1beta2
- Video frame level annotation results for label detection.
- LabelSegment — Class in namespace Google\Cloud\VideoIntelligence\V1beta2
- Video segment level annotation results for label detection.
- Likelihood — Class in namespace Google\Cloud\VideoIntelligence\V1beta2
- Bucketized representation of likelihood.
- LatLongRect — Class in namespace Google\Cloud\Vision\V1
- Rectangle determined by min and max
LatLngpairs. - Likelihood — Class in namespace Google\Cloud\Vision\V1
- A bucketized representation of likelihood, which is intended to give clients highly stable results across model upgrades.
- LocationInfo — Class in namespace Google\Cloud\Vision\V1
- Detected entity location information.
- ListOperationsRequest — Class in namespace Google\LongRunning
- The request message for [Operations.ListOperations][google.longrunning.Operations.ListOperations].
- ListOperationsResponse — Class in namespace Google\LongRunning
- The response message for [Operations.ListOperations][google.longrunning.Operations.ListOperations].
- OperationsGrpcClient::ListOperations() — Method in class OperationsGrpcClient
- Lists operations that match the specified filter in the request. If the
server doesn't support this method, it returns
UNIMPLEMENTED. - LocalizedMessage — Class in namespace Google\Rpc
- Provides a localized error message that is safe to return to the user which can be attached to an RPC error.
- LatLng — Class in namespace Google\Type
- An object representing a latitude/longitude pair. This is expressed as a pair of doubles representing degrees latitude and degrees longitude. Unless specified otherwise, this must conform to the WGS84 standard. Values must be within normalized ranges.
M
- GapicClientTrait::modifyClientOptions() — Method in class GapicClientTrait
- Modify options passed to the client before calling setClientOptions.
- GapicClientTrait::modifyUnaryCallable() — Method in class GapicClientTrait
- Modify the unary callable.
- GapicClientTrait::modifyStreamingCallable() — Method in class GapicClientTrait
- Modify the streaming callable.
- $Parser#match — Property in class Parser
- $Parser#matched — Property in class Parser
- $Parser#more — Property in class Parser
- Parser::more() — Method in class Parser
- PathTemplate::match() — Method in class PathTemplate
- Matches a fully qualified path template string.
- MockBidiStreamingCall — Class in namespace Google\ApiCore\Testing
- The MockBidiStreamingCall class is used to mock out the \Grpc\BidiStreamingCall class (https://github.com/grpc/grpc/blob/master/src/php/lib/Grpc/BidiStreamingCall.php)
- MockClientStreamingCall — Class in namespace Google\ApiCore\Testing
- The MockClientStreamingCall class is used to mock out the \Grpc\ClientStreamingCall class (https://github.com/grpc/grpc/blob/master/src/php/lib/Grpc/ClientStreamingCall.php)
- MockGrpcTransport — Class in namespace Google\ApiCore\Testing
- MockRequest — Class in namespace Google\ApiCore\Testing
- Generated from protobuf message
google.apicore.testing.MockRequest - MockRequestBody — Class in namespace Google\ApiCore\Testing
- Generated from protobuf message
google.apicore.testing.MockRequestBody - MockResponse — Class in namespace Google\ApiCore\Testing
- Generated from protobuf message
google.apicore.testing.MockResponse - MockServerStreamingCall — Class in namespace Google\ApiCore\Testing
- The MockServerStreamingCall class is used to mock out the \Grpc\ServerStreamingCall class (https://github.com/grpc/grpc/blob/master/src/php/lib/Grpc/ServerStreamingCall.php)
- MockStatus — Class in namespace Google\ApiCore\Testing
- $MockStatus#metadata — Property in class MockStatus
- MockStubTrait — Class in namespace Google\ApiCore\Testing
- The MockStubTrait is used by generated mock stub classes which extent \Grpc\BaseStub (https://github.com/grpc/grpc/blob/master/src/php/lib/Grpc/BaseStub.php) It provides functionality to add responses, get received calls, and overrides the _simpleRequest method so that the elements of $responses are returned instead of making a call to the API.
- MockTransport — Class in namespace Google\ApiCore\Testing
- MockUnaryCall — Class in namespace Google\ApiCore\Testing
- The MockUnaryCall class is used to mock out the \Grpc\UnaryCall class (https://github.com/grpc/grpc/blob/master/src/php/lib/Grpc/UnaryCall.php)
- Metric — Class in namespace Google\Api
- A specific metric, identified by specifying values for all of the
labels of a [
MetricDescriptor][google.api.MetricDescriptor]. - MetricDescriptor — Class in namespace Google\Api
- Defines a metric type and its schema. Once a metric descriptor is created, deleting or altering it stops data collection and makes the metric type's existing data unusable.
- MetricDescriptor_MetricKind — Class in namespace Google\Api
- The kind of measurement. It describes how the data is reported.
- MetricDescriptor_ValueType — Class in namespace Google\Api
- The value type of a metric.
- MetricRule — Class in namespace Google\Api
- Bind API methods to metrics. Binding a method to a metric causes that metric's configured quota, billing, and monitoring behaviors to apply to the method call.
- MonitoredResource — Class in namespace Google\Api
- An object representing a resource that can be used for monitoring, logging,
billing, or other purposes. Examples include virtual machine instances,
databases, and storage devices such as disks. The
typefield identifies a [MonitoredResourceDescriptor][google.api.MonitoredResourceDescriptor] object that describes the resource's schema. Information in thelabelsfield identifies the actual resource and its attributes according to the schema. For example, a particular Compute Engine VM instance could be represented by the following object, because the [MonitoredResourceDescriptor][google.api.MonitoredResourceDescriptor] for"gce_instance"has labels"instance_id"and"zone": { "type": "gce_instance", "labels": { "instance_id": "12345678901234", "zone": "us-central1-a" }} - MonitoredResourceDescriptor — Class in namespace Google\Api
- An object that describes the schema of a [MonitoredResource][google.api.MonitoredResource] object using a
type name and a set of labels. For example, the monitored resource
descriptor for Google Compute Engine VM instances has a type of
"gce_instance"and specifies the use of the labels"instance_id"and"zone"to identify particular VM instances. - Monitoring — Class in namespace Google\Api
- Monitoring configuration of the service.
- Monitoring_MonitoringDestination — Class in namespace Google\Api
- Configuration of a specific monitoring destination (the producer project or the consumer project).
- BigtableTableAdminGrpcClient::ModifyColumnFamilies() — Method in class BigtableTableAdminGrpcClient
- Performs a series of column family modifications on the specified table.
- ModifyColumnFamiliesRequest — Class in namespace Google\Cloud\Bigtable\Admin\V2
- Request message for [google.bigtable.admin.v2.BigtableTableAdmin.ModifyColumnFamilies][google.bigtable.admin.v2.BigtableTableAdmin.ModifyColumnFamilies]
- ModifyColumnFamiliesRequest_Modification — Class in namespace Google\Cloud\Bigtable\Admin\V2
- A create, update, or delete of a particular column family.
- $ModifyColumnFamiliesRequest_Modification#mod — Property in class ModifyColumnFamiliesRequest_Modification
- BigtableGrpcClient::MutateRow() — Method in class BigtableGrpcClient
- Mutates a row atomically. Cells already present in the row are left
unchanged unless explicitly changed by
mutation. - BigtableGrpcClient::MutateRows() — Method in class BigtableGrpcClient
- Mutates multiple rows in a batch. Each individual row is mutated atomically as in MutateRow, but the entire batch is not executed atomically.
- MutateRowRequest — Class in namespace Google\Cloud\Bigtable\V2
- Request message for Bigtable.MutateRow.
- MutateRowResponse — Class in namespace Google\Cloud\Bigtable\V2
- Response message for Bigtable.MutateRow.
- MutateRowsRequest — Class in namespace Google\Cloud\Bigtable\V2
- Request message for BigtableService.MutateRows.
- MutateRowsRequest_Entry — Class in namespace Google\Cloud\Bigtable\V2
- Generated from protobuf message
google.bigtable.v2.MutateRowsRequest.Entry - MutateRowsResponse — Class in namespace Google\Cloud\Bigtable\V2
- Response message for BigtableService.MutateRows.
- MutateRowsResponse_Entry — Class in namespace Google\Cloud\Bigtable\V2
- Generated from protobuf message
google.bigtable.v2.MutateRowsResponse.Entry - Mutation — Class in namespace Google\Cloud\Bigtable\V2
- Specifies a particular change to be made to the contents of a row.
- $Mutation#mutation — Property in class Mutation
- Mutation_DeleteFromColumn — Class in namespace Google\Cloud\Bigtable\V2
- A Mutation which deletes cells from the specified column, optionally restricting the deletions to a given timestamp range.
- Mutation_DeleteFromFamily — Class in namespace Google\Cloud\Bigtable\V2
- A Mutation which deletes all cells from the specified column family.
- Mutation_DeleteFromRow — Class in namespace Google\Cloud\Bigtable\V2
- A Mutation which deletes all cells from the containing row.
- Mutation_SetCell — Class in namespace Google\Cloud\Bigtable\V2
- A Mutation which sets the value of the specified cell.
- MaintenancePolicy — Class in namespace Google\Cloud\Container\V1
- MaintenancePolicy defines the maintenance policy to be used for the cluster.
- MaintenanceWindow — Class in namespace Google\Cloud\Container\V1
- MaintenanceWindow defines the maintenance window to be used for the cluster.
- MasterAuth — Class in namespace Google\Cloud\Container\V1
- The authentication information for accessing the master endpoint.
- MasterAuthorizedNetworksConfig — Class in namespace Google\Cloud\Container\V1
- Master authorized networks is a Beta feature.
- MasterAuthorizedNetworksConfig_CidrBlock — Class in namespace Google\Cloud\Container\V1
- CidrBlock contains an optional name and one CIDR block.
- ManagedGroupConfig — Class in namespace Google\Cloud\Dataproc\V1
- Specifies the resources used to actively manage an instance group.
- $Intent_Message#message — Property in class Intent_Message
- $DateShiftConfig#method — Property in class DateShiftConfig
- MapValue — Class in namespace Google\Cloud\Firestore\V1beta1
- A map value.
- $TransactionOptions#mode — Property in class TransactionOptions
- DeviceManagerGrpcClient::ModifyCloudToDeviceConfig() — Method in class DeviceManagerGrpcClient
- Modifies the configuration for the device, which is eventually sent from the Cloud IoT Core servers. Returns the modified configuration version and its metadata.
- ModifyCloudToDeviceConfigRequest — Class in namespace Google\Cloud\Iot\V1
- Request for
ModifyCloudToDeviceConfig. - MqttConfig — Class in namespace Google\Cloud\Iot\V1
- The configuration of MQTT for a device registry.
- MqttState — Class in namespace Google\Cloud\Iot\V1
- Indicates whether an MQTT connection is enabled or disabled. See the field description for details.
- MetricsServiceV2GrpcClient — Class in namespace Google\Cloud\Logging\V2
- Service for configuring logs-based metrics.
- MetricServiceGrpcClient — Class in namespace Google\Cloud\Monitoring\V3
- Manages metric descriptors, monitored resource descriptors, and time series data.
- MutationRecord — Class in namespace Google\Cloud\Monitoring\V3
- Describes a change made to a configuration.
- ModifyAckDeadlineRequest — Class in namespace Google\Cloud\PubSub\V1
- Request for the ModifyAckDeadline method.
- ModifyPushConfigRequest — Class in namespace Google\Cloud\PubSub\V1
- Request for the ModifyPushConfig method.
- SubscriberGrpcClient::ModifyAckDeadline() — Method in class SubscriberGrpcClient
- Modifies the ack deadline for a specific message. This method is useful
to indicate that more time is needed to process a message by the
subscriber, or to make the message available for redelivery if the
processing was interrupted. Note that this does not modify the
subscription-level
ackDeadlineSecondsused for subsequent messages. - SubscriberGrpcClient::ModifyPushConfig() — Method in class SubscriberGrpcClient
- Modifies the
PushConfigfor a specified subscription. - Mutation — Class in namespace Google\Cloud\Spanner\V1
- A modification to one or more Cloud Spanner rows. Mutations can be applied to a Cloud Spanner database by sending them in a [Commit][google.spanner.v1.Spanner.Commit] call.
- Mutation_Delete — Class in namespace Google\Cloud\Spanner\V1
- Arguments to [delete][google.spanner.v1.Mutation.delete] operations.
- Mutation_Write — Class in namespace Google\Cloud\Spanner\V1
- Arguments to [insert][google.spanner.v1.Mutation.insert], [update][google.spanner.v1.Mutation.update], [insert_or_update][google.spanner.v1.Mutation.insert_or_update], and [replace][google.spanner.v1.Mutation.replace] operations.
- $TransactionOptions#mode — Property in class TransactionOptions
- Module — Class in namespace Google\Cloud\Trace\V2
- Binary module.
- Money — Class in namespace Google\Type
- Represents an amount of money with its currency type.
N
- $Parser#none — Property in class Parser
- Parser::next() — Method in class Parser
- $ParserSymbol#name — Property in class ParserSymbol
- NetworkPolicy — Class in namespace Google\Cloud\Container\V1
- Configuration options for the NetworkPolicy feature.
- NetworkPolicyConfig — Class in namespace Google\Cloud\Container\V1
- Configuration for NetworkPolicy. This only tracks whether the addon is enabled or not on the Master, it does not track whether network policy is enabled for the nodes.
- NetworkPolicy_Provider — Class in namespace Google\Cloud\Container\V1
- Allowed Network Policy providers.
- NodeConfig — Class in namespace Google\Cloud\Container\V1
- Parameters that describe the nodes in a cluster.
- NodeManagement — Class in namespace Google\Cloud\Container\V1
- NodeManagement defines the set of node management services turned on for the node pool.
- NodePool — Class in namespace Google\Cloud\Container\V1
- NodePool contains the name and configuration for a cluster's node pool.
- NodePoolAutoscaling — Class in namespace Google\Cloud\Container\V1
- NodePoolAutoscaling contains information required by cluster autoscaler to adjust the size of the node pool to the current cluster usage.
- NodePool_Status — Class in namespace Google\Cloud\Container\V1
- The current status of the node pool instance.
- NodeInitializationAction — Class in namespace Google\Cloud\Dataproc\V1
- Specifies an executable to run on a fully configured node and a timeout period for executable completion.
- NotificationChannel — Class in namespace Google\Cloud\Monitoring\V3
- A
NotificationChannelis a medium through which an alert is delivered when a policy violation is detected. Examples of channels include email, SMS, and third-party messaging applications. Fields containing sensitive information like authentication tokens or contact info are only partially populated on retrieval. - NotificationChannelDescriptor — Class in namespace Google\Cloud\Monitoring\V3
- A description of a notification channel. The descriptor includes the properties of the channel and the set of labels or fields that must be specified to configure channels of a given type.
- NotificationChannelServiceGrpcClient — Class in namespace Google\Cloud\Monitoring\V3
- The Notification Channel API provides access to configuration that controls how messages related to incidents are sent.
- NotificationChannel_VerificationStatus — Class in namespace Google\Cloud\Monitoring\V3
- Indicates whether the channel has been verified or not. It is illegal
to specify this field in a
[
CreateNotificationChannel][google.monitoring.v3.NotificationChannelService.CreateNotificationChannel] or an [UpdateNotificationChannel][google.monitoring.v3.NotificationChannelService.UpdateNotificationChannel] operation. - $RetryConfig#num_attempts — Property in class RetryConfig
- NormalizedBoundingBox — Class in namespace Google\Cloud\VideoIntelligence\V1
- Normalized bounding box.
- NormalizedBoundingBox — Class in namespace Google\Cloud\VideoIntelligence\V1beta2
- Normalized bounding box.
- NormalizedVertex — Class in namespace Google\Cloud\Vision\V1
- A vertex represents a 2D point in the image.
O
- $Parser#offset — Property in class Parser
- OperationsGapicClient — Class in namespace Google\ApiCore\LongRunning\Gapic
- Service Description: Manages long-running operations with an API service.
- OperationsClient — Class in namespace Google\ApiCore\LongRunning
- {@inheritdoc}
- OperationsMiddleware — Class in namespace Google\ApiCore\Middleware
- Middleware which wraps the response in an OperationResponse object.
- OptionsFilterMiddleware — Class in namespace Google\ApiCore\Middleware
- Middleware which filters the $options array.
- OperationResponse — Class in namespace Google\ApiCore
- Response object from a long running API method.
- OperationResponse::operationSucceeded() — Method in class OperationResponse
- Check whether the operation completed successfully. If the operation is not complete, or if the operation failed, return false.
- OperationResponse::operationFailed() — Method in class OperationResponse
- Check whether the operation failed. If the operation is not complete, or if the operation succeeded, return false.
- $Distribution_BucketOptions#options — Property in class Distribution_BucketOptions
- OAuthRequirements — Class in namespace Google\Api
- OAuth scopes are a way to define data and permissions on data. For example, there are scopes defined for "Read-only access to Google Calendar" and "Access to Cloud Platform". Users can consent to a scope for an application, giving it permission to access that data on their behalf.
- Operation — Class in namespace Google\Cloud\Container\V1
- This operation resource represents operations that may have happened or are happening on the cluster. All fields are output only.
- Operation_Status — Class in namespace Google\Cloud\Container\V1
- Current status of the operation.
- Operation_Type — Class in namespace Google\Cloud\Container\V1
- Operation type.
- OriginalDetectIntentRequest — Class in namespace Google\Cloud\Dialogflow\V2
- Represents the contents of the original request that was passed to
the
[Streaming]DetectIntentcall. - OutputStorageConfig — Class in namespace Google\Cloud\Dlp\V2
- Cloud repository for storing output.
- OutputStorageConfig_OutputSchema — Class in namespace Google\Cloud\Dlp\V2
- Predefined schemas for storing findings.
- $Schedule#option — Property in class Schedule
- $StructuredQuery_UnaryFilter#operand_type — Property in class StructuredQuery_UnaryFilter
- $Write#operation — Property in class Write
- OsLoginServiceGrpcClient — Class in namespace Google\Cloud\OsLogin\V1beta
- Cloud OS Login API
- $Mutation#operation — Property in class Mutation
- OperationMetadata — Class in namespace Google\Cloud\Vision\V1
- Contains metadata for the BatchAnnotateImages operation.
- OperationMetadata_State — Class in namespace Google\Cloud\Vision\V1
- Batch operation states.
- OutputConfig — Class in namespace Google\Cloud\Vision\V1
- The desired output location and metadata.
- Operation — Class in namespace Google\LongRunning
- This resource represents a long-running operation that is the result of a network API call.
- OperationsGrpcClient — Class in namespace Google\LongRunning
- Manages long-running operations with an API service.
P
- Parser — Class in namespace Google\ApiCore\Jison
- $Parser#productions — Property in class Parser
- Parser::parserPerformAction() — Method in class Parser
- Parser::parserLex() — Method in class Parser
- Parser::parseError() — Method in class Parser
- Parser::parse() — Method in class Parser
- Parser::pastInput() — Method in class Parser
- Parser::popState() — Method in class Parser
- ParserAction — Class in namespace Google\ApiCore\Jison
- ParserCachedAction — Class in namespace Google\ApiCore\Jison
- ParserError — Class in namespace Google\ApiCore\Jison
- ParserLocation — Class in namespace Google\ApiCore\Jison
- ParserProduction — Class in namespace Google\ApiCore\Jison
- ParserRange — Class in namespace Google\ApiCore\Jison
- ParserState — Class in namespace Google\ApiCore\Jison
- ParserSymbol — Class in namespace Google\ApiCore\Jison
- ParserValue — Class in namespace Google\ApiCore\Jison
- PagedMiddleware — Class in namespace Google\ApiCore\Middleware
- Middleware which wraps the response in an PagedListResponses object.
- OperationResponse::pollUntilComplete() — Method in class OperationResponse
- Poll the server in a loop until the operation is complete.
- Page — Class in namespace Google\ApiCore
- A Page object wraps an API list method response and provides methods to retrieve additional pages using the page token.
- PageStreamingDescriptor — Class in namespace Google\ApiCore
- Holds the description information used for page streaming.
- PagedListResponse — Class in namespace Google\ApiCore
- Response object for paged results from a list API method
- Parser — Class in namespace Google\ApiCore
- Parser used by {see PathTemplate} to parse path template strings
- Parser::parse() — Method in class Parser
- Returns an array of path template segments parsed from data.
- PathTemplate — Class in namespace Google\ApiCore
- Represents a path template.
- PollingTrait — Class in namespace Google\ApiCore
- MockBidiStreamingCall::popReceivedCalls() — Method in class MockBidiStreamingCall
- Return a list of calls made to write(), and clear $receivedFuncCalls.
- MockClientStreamingCall::popReceivedCalls() — Method in class MockClientStreamingCall
- Return a list of calls made to write(), and clear $receivedFuncCalls.
- MockStubTrait::popReceivedCalls() — Method in class MockStubTrait
- Return a list of calls made to _simpleRequest, and clear $receivedFuncCalls.
- MockStubTrait::popCallObjects() — Method in class MockStubTrait
- $HttpRule#pattern — Property in class HttpRule
- Page — Class in namespace Google\Api
- Represents a documentation page. A page can contain subpages to represent nested documentation set structure.
- ProjectProperties — Class in namespace Google\Api
- A descriptor for defining project properties for a service. One service may have many consumer projects, and the service may want to behave differently depending on some properties on the project. For example, a project may be associated with a school, or a business, or a government agency, a business type property on the project may affect how a service responds to the client.
- Property — Class in namespace Google\Api
- Defines project properties.
- Property_PropertyType — Class in namespace Google\Api
- Supported data type of the property values
- BigtableInstanceAdminGrpcClient::PartialUpdateInstance() — Method in class BigtableInstanceAdminGrpcClient
- Partially updates an instance within a project.
- PartialUpdateInstanceRequest — Class in namespace Google\Cloud\Bigtable\Admin\V2
- Request message for BigtableInstanceAdmin.PartialUpdateInstance.
- $MaintenanceWindow#policy — Property in class MaintenanceWindow
- PigJob — Class in namespace Google\Cloud\Dataproc\V1
- A Cloud Dataproc job for running Apache Pig queries on YARN.
- PySparkJob — Class in namespace Google\Cloud\Dataproc\V1
- A Cloud Dataproc job for running Apache PySpark applications on YARN.
- ProjectRepoId — Class in namespace Google\Cloud\DevTools\Source\V1
- Selects a repo using a Google Cloud Platform project ID (e.g. winged-cargo-31) and a repo name within that project.
- PartitionId — Class in namespace Google\Cloud\Dlp\V2
- Datastore partition ID.
- PrimitiveTransformation — Class in namespace Google\Cloud\Dlp\V2
- A rule for transforming a value.
- PrivacyMetric — Class in namespace Google\Cloud\Dlp\V2
- Privacy metric to compute for reidentification risk analysis.
- PrivacyMetric_CategoricalStatsConfig — Class in namespace Google\Cloud\Dlp\V2
- Compute numerical stats over an individual column, including number of distinct values and value count distribution.
- PrivacyMetric_KAnonymityConfig — Class in namespace Google\Cloud\Dlp\V2
- k-anonymity metric, used for analysis of reidentification risk.
- PrivacyMetric_KMapEstimationConfig — Class in namespace Google\Cloud\Dlp\V2
- Reidentifiability metric. This corresponds to a risk model similar to what is called "journalist risk" in the literature, except the attack dataset is statistically modeled instead of being perfectly known. This can be done using publicly available data (like the US Census), or using a custom statistical model (indicated as one or several BigQuery tables), or by extrapolating from the distribution of values in the input dataset.
- PrivacyMetric_KMapEstimationConfig_AuxiliaryTable — Class in namespace Google\Cloud\Dlp\V2
- An auxiliary table contains statistical information on the relative frequency of different quasi-identifiers values. It has one or several quasi-identifiers columns, and one column that indicates the relative frequency of each quasi-identifier tuple.
- PrivacyMetric_KMapEstimationConfig_AuxiliaryTable_QuasiIdField — Class in namespace Google\Cloud\Dlp\V2
- A quasi-identifier column has a custom_tag, used to know which column in the data corresponds to which column in the statistical model.
- PrivacyMetric_KMapEstimationConfig_TaggedField — Class in namespace Google\Cloud\Dlp\V2
- Generated from protobuf message
google.privacy.dlp.v2.PrivacyMetric.KMapEstimationConfig.TaggedField - PrivacyMetric_LDiversityConfig — Class in namespace Google\Cloud\Dlp\V2
- l-diversity metric, used for analysis of reidentification risk.
- PrivacyMetric_NumericalStatsConfig — Class in namespace Google\Cloud\Dlp\V2
- Compute numerical stats over an individual column, including min, max, and quantiles.
- $QuoteInfo#parsed_quote — Property in class QuoteInfo
- Precondition — Class in namespace Google\Cloud\Firestore\V1beta1
- A precondition on a document, used for conditional operations.
- Policy — Class in namespace Google\Cloud\Iam\V1
- Defines an Identity and Access Management (IAM) policy. It is used to specify access control policies for Cloud Platform resources.
- PolicyDelta — Class in namespace Google\Cloud\Iam\V1
- The difference delta between two policies.
- PublicKeyCertificate — Class in namespace Google\Cloud\Iot\V1
- A public key certificate format and data.
- PublicKeyCertificateFormat — Class in namespace Google\Cloud\Iot\V1
- The supported formats for the public key.
- PublicKeyCredential — Class in namespace Google\Cloud\Iot\V1
- A public key format and data.
- PublicKeyFormat — Class in namespace Google\Cloud\Iot\V1
- The supported formats for the public key.
- PartOfSpeech — Class in namespace Google\Cloud\Language\V1beta2
- Represents part of speech information for a token.
- PartOfSpeech_Aspect — Class in namespace Google\Cloud\Language\V1beta2
- The characteristic of a verb that expresses time flow during an event.
- PartOfSpeech_Case — Class in namespace Google\Cloud\Language\V1beta2
- The grammatical function performed by a noun or pronoun in a phrase, clause, or sentence. In some languages, other parts of speech, such as adjective and determiner, take case inflection in agreement with the noun.
- PartOfSpeech_Form — Class in namespace Google\Cloud\Language\V1beta2
- Depending on the language, Form can be categorizing different forms of verbs, adjectives, adverbs, etc. For example, categorizing inflected endings of verbs and adjectives or distinguishing between short and long forms of adjectives and participles
- PartOfSpeech_Gender — Class in namespace Google\Cloud\Language\V1beta2
- Gender classes of nouns reflected in the behaviour of associated words.
- PartOfSpeech_Mood — Class in namespace Google\Cloud\Language\V1beta2
- The grammatical feature of verbs, used for showing modality and attitude.
- PartOfSpeech_Number — Class in namespace Google\Cloud\Language\V1beta2
- Count distinctions.
- PartOfSpeech_Person — Class in namespace Google\Cloud\Language\V1beta2
- The distinction between the speaker, second person, third person, etc.
- PartOfSpeech_Proper — Class in namespace Google\Cloud\Language\V1beta2
- This category shows if the token is part of a proper name.
- PartOfSpeech_Reciprocity — Class in namespace Google\Cloud\Language\V1beta2
- Reciprocal features of a pronoun.
- PartOfSpeech_Tag — Class in namespace Google\Cloud\Language\V1beta2
- The part of speech tags enum.
- PartOfSpeech_Tense — Class in namespace Google\Cloud\Language\V1beta2
- Time reference.
- PartOfSpeech_Voice — Class in namespace Google\Cloud\Language\V1beta2
- The relationship between the action that a verb expresses and the participants identified by its arguments.
- $LogEntry#payload — Property in class LogEntry
- Point — Class in namespace Google\Cloud\Monitoring\V3
- A single data point in a time series.
- PosixAccount — Class in namespace Google\Cloud\OsLogin\Common
- The POSIX account information associated with a Google account.
- PublishRequest — Class in namespace Google\Cloud\PubSub\V1
- Request for the Publish method.
- PublishResponse — Class in namespace Google\Cloud\PubSub\V1
- Response for the
Publishmethod. - PublisherGrpcClient — Class in namespace Google\Cloud\PubSub\V1
- The service that an application uses to manipulate topics, and to send messages to a topic.
- PublisherGrpcClient::Publish() — Method in class PublisherGrpcClient
- Adds one or more messages to the topic. Returns
NOT_FOUNDif the topic does not exist. The message payload must not be empty; it must contain either a non-empty data field, or at least one attribute. - PubsubMessage — Class in namespace Google\Cloud\PubSub\V1
- A message data and its attributes. The message payload must not be empty; it must contain either a non-empty data field, or at least one attribute.
- PullRequest — Class in namespace Google\Cloud\PubSub\V1
- Request for the
Pullmethod. - PullResponse — Class in namespace Google\Cloud\PubSub\V1
- Response for the
Pullmethod. - PushConfig — Class in namespace Google\Cloud\PubSub\V1
- Configuration for a push delivery endpoint.
- SubscriberGrpcClient::Pull() — Method in class SubscriberGrpcClient
- Pulls messages from the server. Returns an empty list if there are no
messages available in the backlog. The server may return
UNAVAILABLEif there are too many concurrent pull requests pending for the given subscription. - PartialResultSet — Class in namespace Google\Cloud\Spanner\V1
- Partial results from a streaming read or SQL query. Streaming reads and SQL queries better tolerate large result sets, large rows, and large values, but are a little trickier to consume.
- Partition — Class in namespace Google\Cloud\Spanner\V1
- Information returned for each partition returned in a PartitionResponse.
- PartitionOptions — Class in namespace Google\Cloud\Spanner\V1
- Options for a PartitionQueryRequest and PartitionReadRequest.
- PartitionQueryRequest — Class in namespace Google\Cloud\Spanner\V1
- The request for [PartitionQuery][google.spanner.v1.Spanner.PartitionQuery]
- PartitionReadRequest — Class in namespace Google\Cloud\Spanner\V1
- The request for [PartitionRead][google.spanner.v1.Spanner.PartitionRead]
- PartitionResponse — Class in namespace Google\Cloud\Spanner\V1
- The response for [PartitionQuery][google.spanner.v1.Spanner.PartitionQuery] or [PartitionRead][google.spanner.v1.Spanner.PartitionRead]
- PlanNode — Class in namespace Google\Cloud\Spanner\V1
- Node information for nodes appearing in a [QueryPlan.plan_nodes][google.spanner.v1.QueryPlan.plan_nodes].
- PlanNode_ChildLink — Class in namespace Google\Cloud\Spanner\V1
- Metadata associated with a parent-child relationship appearing in a [PlanNode][google.spanner.v1.PlanNode].
- PlanNode_Kind — Class in namespace Google\Cloud\Spanner\V1
- The kind of [PlanNode][google.spanner.v1.PlanNode]. Distinguishes between the two different kinds of nodes that can appear in a query plan.
- PlanNode_ShortRepresentation — Class in namespace Google\Cloud\Spanner\V1
- Condensed representation of a node and its subtree. Only present for
SCALAR[PlanNode(s)][google.spanner.v1.PlanNode]. - SpannerGrpcClient::PartitionQuery() — Method in class SpannerGrpcClient
- Creates a set of partition tokens that can be used to execute a query operation in parallel. Each of the returned partition tokens can be used by [ExecuteStreamingSql][google.spanner.v1.Spanner.ExecuteStreamingSql] to specify a subset of the query result to read. The same session and read-only transaction must be used by the PartitionQueryRequest used to create the partition tokens and the ExecuteSqlRequests that use the partition tokens.
- SpannerGrpcClient::PartitionRead() — Method in class SpannerGrpcClient
- Creates a set of partition tokens that can be used to execute a read operation in parallel. Each of the returned partition tokens can be used by [StreamingRead][google.spanner.v1.Spanner.StreamingRead] to specify a subset of the read result to read. The same session and read-only transaction must be used by the PartitionReadRequest used to create the partition tokens and the ReadRequests that use the partition tokens.
- CloudTasksGrpcClient::PurgeQueue() — Method in class CloudTasksGrpcClient
- Purges a queue by deleting all of its tasks.
- CloudTasksGrpcClient::PauseQueue() — Method in class CloudTasksGrpcClient
- Pauses the queue.
- PauseQueueRequest — Class in namespace Google\Cloud\Tasks\V2beta2
- Request message for [PauseQueue][google.cloud.tasks.v2beta2.CloudTasks.PauseQueue].
- PullMessage — Class in namespace Google\Cloud\Tasks\V2beta2
- The pull message contains data that can be used by the caller of [LeaseTasks][google.cloud.tasks.v2beta2.CloudTasks.LeaseTasks] to process the task.
- PullTarget — Class in namespace Google\Cloud\Tasks\V2beta2
- Pull target.
- PurgeQueueRequest — Class in namespace Google\Cloud\Tasks\V2beta2
- Request message for [PurgeQueue][google.cloud.tasks.v2beta2.CloudTasks.PurgeQueue].
- $Task#payload_type — Property in class Task
- Page — Class in namespace Google\Cloud\Vision\V1
- Detected page from OCR.
- Paragraph — Class in namespace Google\Cloud\Vision\V1
- Structural unit of text representing a number of words in certain order.
- Position — Class in namespace Google\Cloud\Vision\V1
- A 3D position in the image, used primarily for Face detection landmarks.
- Property — Class in namespace Google\Cloud\Vision\V1
- A
Propertyconsists of a user-supplied name/value pair. - PreconditionFailure — Class in namespace Google\Rpc
- Describes what preconditions have failed.
- PreconditionFailure_Violation — Class in namespace Google\Rpc
- A message type used to describe a single precondition failure.
- PostalAddress — Class in namespace Google\Type
- Represents a postal address, e.g. for postal delivery or payments addresses.
Q
- Quota — Class in namespace Google\Api
- Quota configuration helps to achieve fairness and budgeting in service usage.
- QuotaLimit — Class in namespace Google\Api
QuotaLimitdefines a specific limit that applies over a specified duration for a limit type. There can be at most one limit for a duration and limit type combination defined within aQuotaGroup.- $HiveJob#queries — Property in class HiveJob
- $PigJob#queries — Property in class PigJob
- QueryList — Class in namespace Google\Cloud\Dataproc\V1
- A list of queries to run on a cluster.
- $SparkSqlJob#queries — Property in class SparkSqlJob
- QueryInput — Class in namespace Google\Cloud\Dialogflow\V2
- Represents the query input. It can contain either: 1. An audio config which instructs the speech recognizer how to process the speech audio.
- QueryParameters — Class in namespace Google\Cloud\Dialogflow\V2
- Represents the parameters of the conversational query.
- QueryResult — Class in namespace Google\Cloud\Dialogflow\V2
- Represents the result of conversational query or event processing.
- QuoteInfo — Class in namespace Google\Cloud\Dlp\V2
- Message for infoType-dependent details parsed from quote.
- QueryTimeRange — Class in namespace Google\Cloud\ErrorReporting\V1beta1
- Requests might be rejected or the resulting timed count durations might be adjusted for lower durations.
- QueryTimeRange_Period — Class in namespace Google\Cloud\ErrorReporting\V1beta1
- The supported time ranges.
- $RunQueryRequest#query_type — Property in class RunQueryRequest
- $Target_QueryTarget#query_type — Property in class Target_QueryTarget
- QueryPlan — Class in namespace Google\Cloud\Spanner\V1
- Contains an ordered list of nodes appearing in the query plan.
- Queue — Class in namespace Google\Cloud\Tasks\V2beta2
- A queue is a container of related tasks. Queues are configured to manage how those tasks are dispatched. Configurable properties include rate limits, retry options, target types, and others.
- Queue_State — Class in namespace Google\Cloud\Tasks\V2beta2
- State of the queue.
- QuotaFailure — Class in namespace Google\Rpc
- Describes how a quota check failed.
- QuotaFailure_Violation — Class in namespace Google\Rpc
- A message type used to describe a single quota violation. For example, a daily quota or a custom quota that was exceeded.
R
- ApiStatus::rpcCodeFromStatus() — Method in class ApiStatus
- ApiStatus::rpcCodeFromHttpStatusCode() — Method in class ApiStatus
- Maps HTTP status codes to Google\Rpc\Code codes.
- BidiStream::read() — Method in class BidiStream
- Read the next response from the server. Returns null if the streaming call completed successfully. Throws an ApiException if the streaming call failed.
- ClientStream::readResponse() — Method in class ClientStream
- Read the response from the server, completing the streaming call.
- $LexerConditions#rules — Property in class LexerConditions
- $Parser#reduce — Property in class Parser
- $Parser#rules — Property in class Parser
- $Parser#ranges — Property in class Parser
- $ParserLocation#range — Property in class ParserLocation
- ParserLocation::Range() — Method in class ParserLocation
- Segment::resetBindingCount() — Method in class Segment
- Segment::resetSegmentCount() — Method in class Segment
- ResponseMetadataMiddleware — Class in namespace Google\ApiCore\Middleware
- Middleware which transforms $response into [$response, $metadata]
- RetryMiddleware — Class in namespace Google\ApiCore\Middleware
- Middleware that adds retry functionality.
- OperationResponse::reload() — Method in class OperationResponse
- Reload the status of the operation with a request to the service.
- PageStreamingDescriptor::requestHasPageSizeField() — Method in class PageStreamingDescriptor
- PathTemplate::render() — Method in class PathTemplate
- Renders a path template using the provided bindings.
- RequestBuilder — Class in namespace Google\ApiCore
- Builds a PSR-7 request from a set of request information.
- RequestParamsHeaderDescriptor — Class in namespace Google\ApiCore
- Encapsulates request params header metadata.
- RetrySettings — Class in namespace Google\ApiCore
- The RetrySettings class is used to configure retrying and timeouts for RPCs.
- RetrySettings::retriesEnabled() — Method in class RetrySettings
- ServerStream::readAll() — Method in class ServerStream
- A generator which yields results from the server until the streaming call completes. Throws an ApiException if the streaming call failed.
- MockBidiStreamingCall::read() — Method in class MockBidiStreamingCall
- MockServerStreamingCall::responses() — Method in class MockServerStreamingCall
- ReceivedRequest — Class in namespace Google\ApiCore\Testing
- Class ReceivedRequest used to hold the function name and request object of a call make to a mock gRPC stub.
- RestTransport — Class in namespace Google\ApiCore\Transport
- A REST based transport implementation.
- RequestMetadata — Class in namespace Google\Cloud\Audit
- Metadata about the request.
- $AppProfile#routing_policy — Property in class AppProfile
- $GcRule#rule — Property in class GcRule
- BigtableGrpcClient::ReadRows() — Method in class BigtableGrpcClient
- Streams back the contents of all requested rows in key order, optionally applying the same Reader filter to each. Depending on their size, rows and cells may be broken up across multiple responses, but atomicity of each row will still be preserved. See the ReadRowsResponse documentation for details.
- BigtableGrpcClient::ReadModifyWriteRow() — Method in class BigtableGrpcClient
- Modifies a row atomically on the server. The method reads the latest existing timestamp and value from the specified columns and writes a new entry based on pre-defined read/modify/write rules. The new value for the timestamp is the greater of the existing timestamp or the current server time. The method returns the new contents of all modified cells.
- ReadModifyWriteRowRequest — Class in namespace Google\Cloud\Bigtable\V2
- Request message for Bigtable.ReadModifyWriteRow.
- ReadModifyWriteRowResponse — Class in namespace Google\Cloud\Bigtable\V2
- Response message for Bigtable.ReadModifyWriteRow.
- ReadModifyWriteRule — Class in namespace Google\Cloud\Bigtable\V2
- Specifies an atomic read/modify/write operation on the latest value of the specified column.
- $ReadModifyWriteRule#rule — Property in class ReadModifyWriteRule
- ReadRowsRequest — Class in namespace Google\Cloud\Bigtable\V2
- Request message for Bigtable.ReadRows.
- ReadRowsResponse — Class in namespace Google\Cloud\Bigtable\V2
- Response message for Bigtable.ReadRows.
- ReadRowsResponse_CellChunk — Class in namespace Google\Cloud\Bigtable\V2
- Specifies a piece of a row's contents returned as part of the read response stream.
- $ReadRowsResponse_CellChunk#row_status — Property in class ReadRowsResponse_CellChunk
- Row — Class in namespace Google\Cloud\Bigtable\V2
- Specifies the complete (requested) contents of a single row of a table.
- RowFilter — Class in namespace Google\Cloud\Bigtable\V2
- Takes a row as input and produces an alternate view of the row based on
specified rules. For example, a RowFilter might trim down a row to include
just the cells from columns matching a given regular expression, or might
return all the cells of a row but not their values. More complicated filters
can be composed out of these components to express requests such as, "within
every column of a particular family, give just the two most recent cells
which are older than timestamp X."
There are two broad categories of RowFilters (true filters and transformers),
as well as two ways to compose simple filters into more complex ones
(chains and interleaves). They work as follows:
* True filters alter the input row by excluding some of its cells wholesale
from the output row. An example of a true filter is the
value_regex_filter, which excludes cells whose values don't match the specified pattern. All regex true filters use RE2 syntax (https://github.com/google/re2/wiki/Syntax) in raw byte mode (RE2::Latin1), and are evaluated as full matches. An important point to keep in mind is thatRE2(.)is equivalent by default toRE2([^\n]), meaning that it does not match newlines. When attempting to match an arbitrary byte, you should therefore use the escape sequence\C, which may need to be further escaped as\\Cin your client language. - RowFilter_Chain — Class in namespace Google\Cloud\Bigtable\V2
- A RowFilter which sends rows through several RowFilters in sequence.
- RowFilter_Condition — Class in namespace Google\Cloud\Bigtable\V2
- A RowFilter which evaluates one of two possible RowFilters, depending on whether or not a predicate RowFilter outputs any cells from the input row.
- RowFilter_Interleave — Class in namespace Google\Cloud\Bigtable\V2
- A RowFilter which sends each row to each of several component RowFilters and interleaves the results.
- RowRange — Class in namespace Google\Cloud\Bigtable\V2
- Specifies a contiguous range of rows.
- RowSet — Class in namespace Google\Cloud\Bigtable\V2
- Specifies a non-contiguous set of rows.
- ClusterManagerGrpcClient::RollbackNodePoolUpgrade() — Method in class ClusterManagerGrpcClient
- Roll back the previously Aborted or Failed NodePool upgrade.
- RollbackNodePoolUpgradeRequest — Class in namespace Google\Cloud\Container\V1
- RollbackNodePoolUpgradeRequest rollbacks the previously Aborted or Failed NodePool upgrade. This will be an no-op if the last upgrade successfully completed.
- Controller2GrpcClient::RegisterDebuggee() — Method in class Controller2GrpcClient
- Registers the debuggee with the controller service.
- RegisterDebuggeeRequest — Class in namespace Google\Cloud\Debugger\V2
- Request to register a debuggee.
- RegisterDebuggeeResponse — Class in namespace Google\Cloud\Debugger\V2
- Response for registering a debuggee.
- $CloudRepoSourceContext#revision — Property in class CloudRepoSourceContext
- $GerritSourceContext#revision — Property in class GerritSourceContext
- RepoId — Class in namespace Google\Cloud\DevTools\Source\V1
- A unique identifier for a cloud repo.
- AgentsGrpcClient::RestoreAgent() — Method in class AgentsGrpcClient
- Restores the specified agent from a ZIP file.
- RestoreAgentRequest — Class in namespace Google\Cloud\Dialogflow\V2
- The request message for [Agents.RestoreAgent][google.cloud.dialogflow.v2.Agents.RestoreAgent].
- $AnalyzeDataSourceRiskDetails#result — Property in class AnalyzeDataSourceRiskDetails
- DlpServiceGrpcClient::RedactImage() — Method in class DlpServiceGrpcClient
- Redacts potentially sensitive info from an image.
- DlpServiceGrpcClient::ReidentifyContent() — Method in class DlpServiceGrpcClient
- Re-identifies content that has been de-identified.
- Range — Class in namespace Google\Cloud\Dlp\V2
- Generic half-open interval [start, end)
- RecordCondition — Class in namespace Google\Cloud\Dlp\V2
- A condition for determining whether a transformation should be applied to a field.
- RecordCondition_Condition — Class in namespace Google\Cloud\Dlp\V2
- The field type of
valueandfielddo not need to match to be considered equal, but not all comparisons are possible. - RecordCondition_Conditions — Class in namespace Google\Cloud\Dlp\V2
- A collection of conditions.
- RecordCondition_Expressions — Class in namespace Google\Cloud\Dlp\V2
- An expression, consisting or an operator and conditions.
- RecordCondition_Expressions_LogicalOperator — Class in namespace Google\Cloud\Dlp\V2
- Protobuf enum
Google\Privacy\Dlp\V2\RecordCondition\Expressions\LogicalOperator - RecordKey — Class in namespace Google\Cloud\Dlp\V2
- Message for a unique key indicating a record that contains a finding.
- RecordLocation — Class in namespace Google\Cloud\Dlp\V2
- Location of a finding within a row or record.
- RecordSuppression — Class in namespace Google\Cloud\Dlp\V2
- Configuration to suppress records whose suppression conditions evaluate to true.
- RecordTransformations — Class in namespace Google\Cloud\Dlp\V2
- A type of transformation that is applied over structured data such as a table.
- RedactConfig — Class in namespace Google\Cloud\Dlp\V2
- Redact a given value. For example, if used with an
InfoTypeTransformationtransforming PHONE_NUMBER, and input 'My phone number is 206-555-0123', the output would be 'My phone number is '. - RedactImageRequest — Class in namespace Google\Cloud\Dlp\V2
- Request to search for potentially sensitive info in a list of items and replace it with a default or provided content.
- RedactImageRequest_ImageRedactionConfig — Class in namespace Google\Cloud\Dlp\V2
- Configuration for determining how redaction of images should occur.
- RedactImageResponse — Class in namespace Google\Cloud\Dlp\V2
- Results of redacting an image.
- ReidentifyContentRequest — Class in namespace Google\Cloud\Dlp\V2
- Request to re-identify an item.
- ReidentifyContentResponse — Class in namespace Google\Cloud\Dlp\V2
- Results of re-identifying a item.
- RelationalOperator — Class in namespace Google\Cloud\Dlp\V2
- Operators available for comparing the value of fields.
- ReplaceValueConfig — Class in namespace Google\Cloud\Dlp\V2
- Replace each input value with a given
Value. - ReplaceWithInfoTypeConfig — Class in namespace Google\Cloud\Dlp\V2
- Replace each matching finding with the name of the info_type.
- RiskAnalysisJobConfig — Class in namespace Google\Cloud\Dlp\V2
- Configuration for a risk analysis job.
- ReportErrorEventRequest — Class in namespace Google\Cloud\ErrorReporting\V1beta1
- A request for reporting an individual error event.
- ReportErrorEventResponse — Class in namespace Google\Cloud\ErrorReporting\V1beta1
- Response for reporting an individual error event.
- ReportErrorsServiceGrpcClient — Class in namespace Google\Cloud\ErrorReporting\V1beta1
- An API for reporting error events.
- ReportErrorsServiceGrpcClient::ReportErrorEvent() — Method in class ReportErrorsServiceGrpcClient
- Report an individual error event.
- ReportedErrorEvent — Class in namespace Google\Cloud\ErrorReporting\V1beta1
- An error event which is reported to the Error Reporting system.
- $BatchGetDocumentsResponse#result — Property in class BatchGetDocumentsResponse
- FirestoreGrpcClient::Rollback() — Method in class FirestoreGrpcClient
- Rolls back a transaction.
- FirestoreGrpcClient::RunQuery() — Method in class FirestoreGrpcClient
- Runs a query.
- $ListenResponse#response_type — Property in class ListenResponse
- RollbackRequest — Class in namespace Google\Cloud\Firestore\V1beta1
- The request for [Firestore.Rollback][google.firestore.v1beta1.Firestore.Rollback].
- RunQueryRequest — Class in namespace Google\Cloud\Firestore\V1beta1
- The request for [Firestore.RunQuery][google.firestore.v1beta1.Firestore.RunQuery].
- RunQueryResponse — Class in namespace Google\Cloud\Firestore\V1beta1
- The response for [Firestore.RunQuery][google.firestore.v1beta1.Firestore.RunQuery].
- $Target#resume_type — Property in class Target
- RegistryCredential — Class in namespace Google\Cloud\Iot\V1
- A server-stored registry credential used to validate device credentials.
- $UptimeCheckConfig#resource — Property in class UptimeCheckConfig
- ReceivedMessage — Class in namespace Google\Cloud\PubSub\V1
- A message and its corresponding acknowledgment ID.
- ReadRequest — Class in namespace Google\Cloud\Spanner\V1
- The request for [Read][google.spanner.v1.Spanner.Read] and [StreamingRead][google.spanner.v1.Spanner.StreamingRead].
- ResultSet — Class in namespace Google\Cloud\Spanner\V1
- Results from [Read][google.spanner.v1.Spanner.Read] or [ExecuteSql][google.spanner.v1.Spanner.ExecuteSql].
- ResultSetMetadata — Class in namespace Google\Cloud\Spanner\V1
- Metadata about a [ResultSet][google.spanner.v1.ResultSet] or [PartialResultSet][google.spanner.v1.PartialResultSet].
- ResultSetStats — Class in namespace Google\Cloud\Spanner\V1
- Additional statistics about a [ResultSet][google.spanner.v1.ResultSet] or [PartialResultSet][google.spanner.v1.PartialResultSet].
- RollbackRequest — Class in namespace Google\Cloud\Spanner\V1
- The request for [Rollback][google.spanner.v1.Spanner.Rollback].
- SpannerGrpcClient::Read() — Method in class SpannerGrpcClient
- Reads rows from the database using key lookups and scans, as a
simple key/value style alternative to
[ExecuteSql][google.spanner.v1.Spanner.ExecuteSql]. This method cannot be used to
return a result set larger than 10 MiB; if the read matches more
data than that, the read fails with a
FAILED_PRECONDITIONerror. - SpannerGrpcClient::Rollback() — Method in class SpannerGrpcClient
- Rolls back a transaction, releasing any locks it holds. It is a good idea to call this for any transaction that includes one or more [Read][google.spanner.v1.Spanner.Read] or [ExecuteSql][google.spanner.v1.Spanner.ExecuteSql] requests and ultimately decides not to commit.
- RecognitionAudio — Class in namespace Google\Cloud\Speech\V1
- Contains audio data in the encoding specified in the
RecognitionConfig. - RecognitionConfig — Class in namespace Google\Cloud\Speech\V1
- Provides information to the recognizer that specifies how to process the request.
- RecognitionConfig_AudioEncoding — Class in namespace Google\Cloud\Speech\V1
- Audio encoding of the data sent in the audio message. All encodings support
only 1 channel (mono) audio. Only
FLACandWAVinclude a header that describes the bytes of audio that follow the header. The other encodings are raw audio bytes with no header. - RecognizeRequest — Class in namespace Google\Cloud\Speech\V1
- The top-level message sent by the client for the
Recognizemethod. - RecognizeResponse — Class in namespace Google\Cloud\Speech\V1
- The only message returned to the client by the
Recognizemethod. It contains the result as zero or more sequentialSpeechRecognitionResultmessages. - SpeechGrpcClient::Recognize() — Method in class SpeechGrpcClient
- Performs synchronous speech recognition: receive results after all audio has been sent and processed.
- RecognitionAudio — Class in namespace Google\Cloud\Speech\V1beta1
- Contains audio data in the encoding specified in the
RecognitionConfig. - RecognitionConfig — Class in namespace Google\Cloud\Speech\V1beta1
- Provides information to the recognizer that specifies how to process the request.
- RecognitionConfig_AudioEncoding — Class in namespace Google\Cloud\Speech\V1beta1
- Audio encoding of the data sent in the audio message. All encodings support
only 1 channel (mono) audio. Only
FLACincludes a header that describes the bytes of audio that follow the header. The other encodings are raw audio bytes with no header. - RecognitionAudio — Class in namespace Google\Cloud\Speech\V1p1beta1
- Contains audio data in the encoding specified in the
RecognitionConfig. - RecognitionConfig — Class in namespace Google\Cloud\Speech\V1p1beta1
- Provides information to the recognizer that specifies how to process the request.
- RecognitionConfig_AudioEncoding — Class in namespace Google\Cloud\Speech\V1p1beta1
- The encoding of the audio data sent in the request.
- RecognitionMetadata — Class in namespace Google\Cloud\Speech\V1p1beta1
- Description of audio data to be recognized.
- RecognitionMetadata_InteractionType — Class in namespace Google\Cloud\Speech\V1p1beta1
- Use case categories that the audio recognition request can be described by.
- RecognitionMetadata_MicrophoneDistance — Class in namespace Google\Cloud\Speech\V1p1beta1
- Enumerates the types of capture settings describing an audio file.
- RecognitionMetadata_OriginalMediaType — Class in namespace Google\Cloud\Speech\V1p1beta1
- The original media the speech was recorded on.
- RecognitionMetadata_RecordingDeviceType — Class in namespace Google\Cloud\Speech\V1p1beta1
- The type of device the speech was recorded with.
- RecognizeRequest — Class in namespace Google\Cloud\Speech\V1p1beta1
- The top-level message sent by the client for the
Recognizemethod. - RecognizeResponse — Class in namespace Google\Cloud\Speech\V1p1beta1
- The only message returned to the client by the
Recognizemethod. It contains the result as zero or more sequentialSpeechRecognitionResultmessages. - SpeechGrpcClient::Recognize() — Method in class SpeechGrpcClient
- Performs synchronous speech recognition: receive results after all audio has been sent and processed.
- CloudTasksGrpcClient::ResumeQueue() — Method in class CloudTasksGrpcClient
- Resume a queue.
- CloudTasksGrpcClient::RenewLease() — Method in class CloudTasksGrpcClient
- Renew the current lease of a pull task.
- CloudTasksGrpcClient::RunTask() — Method in class CloudTasksGrpcClient
- Forces a task to run now.
- RateLimits — Class in namespace Google\Cloud\Tasks\V2beta2
- Rate limits.
- RenewLeaseRequest — Class in namespace Google\Cloud\Tasks\V2beta2
- Request message for renewing a lease using [RenewLease][google.cloud.tasks.v2beta2.CloudTasks.RenewLease].
- ResumeQueueRequest — Class in namespace Google\Cloud\Tasks\V2beta2
- Request message for [ResumeQueue][google.cloud.tasks.v2beta2.CloudTasks.ResumeQueue].
- RetryConfig — Class in namespace Google\Cloud\Tasks\V2beta2
- Retry config.
- RunTaskRequest — Class in namespace Google\Cloud\Tasks\V2beta2
- Request message for forcing a task to run now using [RunTask][google.cloud.tasks.v2beta2.CloudTasks.RunTask].
- $Operation#result — Property in class Operation
- RequestInfo — Class in namespace Google\Rpc
- Contains metadata about the request that clients can attach when filing a bug or providing other forms of feedback.
- ResourceInfo — Class in namespace Google\Rpc
- Describes the resource that is being accessed.
- RetryInfo — Class in namespace Google\Rpc
- Describes when the clients can retry a failed request. Clients could ignore the recommendation here or retry when this information is missing from error responses.
S
- ApiStatus::statusFromRpcCode() — Method in class ApiStatus
- $Parser#symbols — Property in class Parser
- $Parser#shift — Property in class Parser
- Parser::setInput() — Method in class Parser
- Parser::showPosition() — Method in class Parser
- $ParserAction#state — Property in class ParserAction
- $ParserAction#symbol — Property in class ParserAction
- $ParserCachedAction#symbol — Property in class ParserCachedAction
- $ParserError#state — Property in class ParserError
- $ParserError#symbol — Property in class ParserError
- $ParserProduction#symbol — Property in class ParserProduction
- ParserState::setActions() — Method in class ParserState
- $ParserSymbol#symbols — Property in class ParserSymbol
- $ParserSymbol#symbolsByName — Property in class ParserSymbol
- Segment — Class in namespace Google\ApiCore\Jison
- This class represents a segment in a path template.
- PollingTrait::sleepMillis() — Method in class PollingTrait
- Protected to allow overriding for tests
- Serializer — Class in namespace Google\ApiCore
- Collection of methods to help with serialization of protobuf objects
- Serializer::serializeToJson() — Method in class Serializer
- Serializer::serializeToPhpArray() — Method in class Serializer
- ServerStream — Class in namespace Google\ApiCore
- ServerStream is the response object from a gRPC server streaming API call.
- ServiceAddressTrait — Class in namespace Google\ApiCore
- Provides helper methods for service address handling.
- MockRequest::setPageToken() — Method in class MockRequest
- Generated from protobuf field
string page_token = 1; - MockRequest::setPageSize() — Method in class MockRequest
- Generated from protobuf field
uint64 page_size = 2; - MockRequestBody::setName() — Method in class MockRequestBody
- Generated from protobuf field
string name = 1; - MockRequestBody::setNumber() — Method in class MockRequestBody
- Generated from protobuf field
uint64 number = 2; - MockRequestBody::setRepeatedField() — Method in class MockRequestBody
- Generated from protobuf field
repeated string repeated_field = 3; - MockRequestBody::setNestedMessage() — Method in class MockRequestBody
- Generated from protobuf field
.google.apicore.testing.MockRequestBody nested_message = 4; - MockRequestBody::setFieldMask() — Method in class MockRequestBody
- Generated from protobuf field
.google.protobuf.FieldMask field_mask = 5; - MockRequestBody::setStringValue() — Method in class MockRequestBody
- Generated from protobuf field
.google.protobuf.StringValue string_value = 6; - MockResponse::setName() — Method in class MockResponse
- Generated from protobuf field
string name = 1; - MockResponse::setNumber() — Method in class MockResponse
- Generated from protobuf field
uint64 number = 2; - MockResponse::setResourcesList() — Method in class MockResponse
- Generated from protobuf field
repeated string resources_list = 3; - MockResponse::setNextPageToken() — Method in class MockResponse
- Generated from protobuf field
string next_page_token = 4; - MockStubTrait::stripStatusFromResponses() — Method in class MockStubTrait
- MockStubTrait::setStreamingStatus() — Method in class MockStubTrait
- Set the status object to be used when creating streaming calls.
- MockTransport::setAgentHeaderDescriptor() — Method in class MockTransport
- MockTransport::startUnaryCall() — Method in class MockTransport
- Returns a promise used to execute network requests.
- MockTransport::startBidiStreamingCall() — Method in class MockTransport
- Starts a bidi streaming call.
- MockTransport::startClientStreamingCall() — Method in class MockTransport
- Starts a client streaming call.
- MockTransport::startServerStreamingCall() — Method in class MockTransport
- Starts a server streaming call.
- SerializationTrait — Class in namespace Google\ApiCore\Testing
- GrpcTransport::startBidiStreamingCall() — Method in class GrpcTransport
- Starts a bidi streaming call.
- GrpcTransport::startClientStreamingCall() — Method in class GrpcTransport
- Starts a client streaming call.
- GrpcTransport::startServerStreamingCall() — Method in class GrpcTransport
- Starts a server streaming call.
- GrpcTransport::startUnaryCall() — Method in class GrpcTransport
- Returns a promise used to execute network requests.
- RestTransport::startClientStreamingCall() — Method in class RestTransport
- Starts a client streaming call.
- RestTransport::startServerStreamingCall() — Method in class RestTransport
- Starts a server streaming call.
- RestTransport::startBidiStreamingCall() — Method in class RestTransport
- Starts a bidi streaming call.
- RestTransport::startUnaryCall() — Method in class RestTransport
- Returns a promise used to execute network requests.
- TransportInterface::startBidiStreamingCall() — Method in class TransportInterface
- Starts a bidi streaming call.
- TransportInterface::startClientStreamingCall() — Method in class TransportInterface
- Starts a client streaming call.
- TransportInterface::startServerStreamingCall() — Method in class TransportInterface
- Starts a server streaming call.
- TransportInterface::startUnaryCall() — Method in class TransportInterface
- Returns a promise used to execute network requests.
- Advice::setDescription() — Method in class Advice
- Useful description for why this advice was applied and what actions should be taken to mitigate any implied risks.
- AuthProvider::setId() — Method in class AuthProvider
- The unique identifier of the auth provider. It will be referred to by
AuthRequirement.provider_id. - AuthProvider::setIssuer() — Method in class AuthProvider
- Identifies the principal that issued the JWT. See https://tools.ietf.org/html/draft-ietf-oauth-json-web-token-32#section-4.1.1 Usually a URL or an email address.
- AuthProvider::setJwksUri() — Method in class AuthProvider
- URL of the provider's public key set to validate signature of the JWT. See OpenID Discovery.
- AuthProvider::setAudiences() — Method in class AuthProvider
- The list of JWT audiences.
- AuthProvider::setAuthorizationUrl() — Method in class AuthProvider
- Redirect URL if JWT token is required but no present or is expired.
- AuthRequirement::setProviderId() — Method in class AuthRequirement
- [id][google.api.AuthProvider.id] from authentication provider.
- AuthRequirement::setAudiences() — Method in class AuthRequirement
- NOTE: This will be deprecated soon, once AuthProvider.audiences is implemented and accepted in all the runtime components.
- Authentication::setRules() — Method in class Authentication
- A list of authentication rules that apply to individual API methods.
- Authentication::setProviders() — Method in class Authentication
- Defines a set of authentication providers that a service supports.
- AuthenticationRule::setSelector() — Method in class AuthenticationRule
- Selects the methods to which this rule applies.
- AuthenticationRule::setOauth() — Method in class AuthenticationRule
- The requirements for OAuth credentials.
- AuthenticationRule::setAllowWithoutCredential() — Method in class AuthenticationRule
- Whether to allow requests without a credential. The credential can be an OAuth token, Google cookies (first-party auth) or EndUserCreds.
- AuthenticationRule::setRequirements() — Method in class AuthenticationRule
- Requirements for additional authentication providers.
- AuthorizationConfig::setProvider() — Method in class AuthorizationConfig
- The name of the authorization provider, such as firebaserules.googleapis.com.
- Backend::setRules() — Method in class Backend
- A list of API backend rules that apply to individual API methods.
- BackendRule::setSelector() — Method in class BackendRule
- Selects the methods to which this rule applies.
- BackendRule::setAddress() — Method in class BackendRule
- The address of the API backend.
- BackendRule::setDeadline() — Method in class BackendRule
- The number of seconds to wait for a response from a request. The default depends on the deployment context.
- Billing::setConsumerDestinations() — Method in class Billing
- Billing configurations for sending metrics to the consumer project.
- Billing_BillingDestination::setMonitoredResource() — Method in class Billing_BillingDestination
- The monitored resource type. The type must be defined in [Service.monitored_resources][google.api.Service.monitored_resources] section.
- Billing_BillingDestination::setMetrics() — Method in class Billing_BillingDestination
- Names of the metrics to report to this billing destination.
- ConfigChange::setElement() — Method in class ConfigChange
- Object hierarchy path to the change, with levels separated by a '.' character. For repeated fields, an applicable unique identifier field is used for the index (usually selector, name, or id). For maps, the term 'key' is used. If the field has no unique identifier, the numeric index is used.
- ConfigChange::setOldValue() — Method in class ConfigChange
- Value of the changed object in the old Service configuration, in JSON format. This field will not be populated if ChangeType == ADDED.
- ConfigChange::setNewValue() — Method in class ConfigChange
- Value of the changed object in the new Service configuration, in JSON format. This field will not be populated if ChangeType == REMOVED.
- ConfigChange::setChangeType() — Method in class ConfigChange
- The type for this change, either ADDED, REMOVED, or MODIFIED.
- ConfigChange::setAdvices() — Method in class ConfigChange
- Collection of advice provided for this change, useful for determining the possible impact of this change.
- Context::setRules() — Method in class Context
- A list of RPC context rules that apply to individual API methods.
- ContextRule::setSelector() — Method in class ContextRule
- Selects the methods to which this rule applies.
- ContextRule::setRequested() — Method in class ContextRule
- A list of full type names of requested contexts.
- ContextRule::setProvided() — Method in class ContextRule
- A list of full type names of provided contexts.
- Control::setEnvironment() — Method in class Control
- The service control environment to use. If empty, no control plane feature (like quota and billing) will be enabled.
- CustomHttpPattern::setKind() — Method in class CustomHttpPattern
- The name of this custom HTTP verb.
- CustomHttpPattern::setPath() — Method in class CustomHttpPattern
- The path matched by this custom verb.
- Distribution::setCount() — Method in class Distribution
- The number of values in the population. Must be non-negative.
- Distribution::setMean() — Method in class Distribution
- The arithmetic mean of the values in the population. If
countis zero then this field must be zero. - Distribution::setSumOfSquaredDeviation() — Method in class Distribution
- The sum of squared deviations from the mean of the values in the population. For values x_i this is: Sum[i=1.
- Distribution::setRange() — Method in class Distribution
- If specified, contains the range of the population values. The field
must not be present if the
countis zero. - Distribution::setBucketOptions() — Method in class Distribution
- Defines the histogram bucket boundaries.
- Distribution::setBucketCounts() — Method in class Distribution
- If
bucket_optionsis given, then the sum of the values inbucket_countsmust equal the value incount. Ifbucket_optionsis not given, nobucket_countsfields may be given. - Distribution_BucketOptions::setLinearBuckets() — Method in class Distribution_BucketOptions
- The linear bucket.
- Distribution_BucketOptions::setExponentialBuckets() — Method in class Distribution_BucketOptions
- The exponential buckets.
- Distribution_BucketOptions::setExplicitBuckets() — Method in class Distribution_BucketOptions
- The explicit buckets.
- Distribution_BucketOptions_Explicit::setBounds() — Method in class Distribution_BucketOptions_Explicit
- The values must be monotonically increasing.
- Distribution_BucketOptions_Exponential::setNumFiniteBuckets() — Method in class Distribution_BucketOptions_Exponential
- Must be greater than 0.
- Distribution_BucketOptions_Exponential::setGrowthFactor() — Method in class Distribution_BucketOptions_Exponential
- Must be greater than 1.
- Distribution_BucketOptions_Exponential::setScale() — Method in class Distribution_BucketOptions_Exponential
- Must be greater than 0.
- Distribution_BucketOptions_Linear::setNumFiniteBuckets() — Method in class Distribution_BucketOptions_Linear
- Must be greater than 0.
- Distribution_BucketOptions_Linear::setWidth() — Method in class Distribution_BucketOptions_Linear
- Must be greater than 0.
- Distribution_BucketOptions_Linear::setOffset() — Method in class Distribution_BucketOptions_Linear
- Lower bound of the first bucket.
- Distribution_Range::setMin() — Method in class Distribution_Range
- The minimum of the population values.
- Distribution_Range::setMax() — Method in class Distribution_Range
- The maximum of the population values.
- Documentation::setSummary() — Method in class Documentation
- A short summary of what the service does. Can only be provided by plain text.
- Documentation::setPages() — Method in class Documentation
- The top level pages for the documentation set.
- Documentation::setRules() — Method in class Documentation
- A list of documentation rules that apply to individual API elements.
- Documentation::setDocumentationRootUrl() — Method in class Documentation
- The URL to the root of documentation.
- Documentation::setOverview() — Method in class Documentation
- Declares a single overview page. For example:
<
pre>
documentation: summary: . - DocumentationRule::setSelector() — Method in class DocumentationRule
- The selector is a comma-separated list of patterns. Each pattern is a qualified name of the element which may end in "*", indicating a wildcard.
- DocumentationRule::setDescription() — Method in class DocumentationRule
- Description of the selected API(s).
- DocumentationRule::setDeprecationDescription() — Method in class DocumentationRule
- Deprecation description of the selected element(s). It can be provided if an
element is marked as
deprecated. - Endpoint::setName() — Method in class Endpoint
- The canonical name of this endpoint.
- Endpoint::setAliases() — Method in class Endpoint
- DEPRECATED: This field is no longer supported. Instead of using aliases, please specify multiple [google.api.Endpoint][google.api.Endpoint] for each of the intented alias.
- Endpoint::setApis() — Method in class Endpoint
- The list of APIs served by this endpoint.
- Endpoint::setFeatures() — Method in class Endpoint
- The list of features enabled on this endpoint.
- Endpoint::setTarget() — Method in class Endpoint
- The specification of an Internet routable address of API frontend that will handle requests to this API Endpoint.
- Endpoint::setAllowCors() — Method in class Endpoint
- Allowing CORS, aka cross-domain traffic, would allow the backends served from this endpoint to receive and respond to HTTP OPTIONS requests. The response will be used by the browser to determine whether the subsequent cross-origin request is allowed to proceed.
- Experimental::setAuthorization() — Method in class Experimental
- Authorization configuration.
- Http::setRules() — Method in class Http
- A list of HTTP configuration rules that apply to individual API methods.
- HttpBody::setContentType() — Method in class HttpBody
- The HTTP Content-Type string representing the content type of the body.
- HttpBody::setData() — Method in class HttpBody
- HTTP body binary data.
- HttpRule::setSelector() — Method in class HttpRule
- Selects methods to which this rule applies.
- HttpRule::setGet() — Method in class HttpRule
- Used for listing and getting information about resources.
- HttpRule::setPut() — Method in class HttpRule
- Used for updating a resource.
- HttpRule::setPost() — Method in class HttpRule
- Used for creating a resource.
- HttpRule::setDelete() — Method in class HttpRule
- Used for deleting a resource.
- HttpRule::setPatch() — Method in class HttpRule
- Used for updating a resource.
- HttpRule::setCustom() — Method in class HttpRule
- Custom pattern is used for defining custom verbs.
- HttpRule::setBody() — Method in class HttpRule
- The name of the request field whose value is mapped to the HTTP body, or
*for mapping all fields not captured by the path pattern to the HTTP body. NOTE: the referred field must not be a repeated field and must be present at the top-level of request message type. - HttpRule::setAdditionalBindings() — Method in class HttpRule
- Additional HTTP bindings for the selector. Nested bindings must
not contain an
additional_bindingsfield themselves (that is, the nesting may only be one level deep). - LabelDescriptor::setKey() — Method in class LabelDescriptor
- The label key.
- LabelDescriptor::setValueType() — Method in class LabelDescriptor
- The type of data that can be assigned to the label.
- LabelDescriptor::setDescription() — Method in class LabelDescriptor
- A human-readable description for the label.
- LogDescriptor::setName() — Method in class LogDescriptor
- The name of the log. It must be less than 512 characters long and can include the following characters: upper- and lower-case alphanumeric characters [A-Za-z0-9], and punctuation characters including slash, underscore, hyphen, period [/_-.].
- LogDescriptor::setLabels() — Method in class LogDescriptor
- The set of labels that are available to describe a specific log entry.
- LogDescriptor::setDescription() — Method in class LogDescriptor
- A human-readable description of this log. This information appears in the documentation and can contain details.
- LogDescriptor::setDisplayName() — Method in class LogDescriptor
- The human-readable name for this log. This information appears on the user interface and should be concise.
- Logging::setProducerDestinations() — Method in class Logging
- Logging configurations for sending logs to the producer project.
- Logging::setConsumerDestinations() — Method in class Logging
- Logging configurations for sending logs to the consumer project.
- Logging_LoggingDestination::setMonitoredResource() — Method in class Logging_LoggingDestination
- The monitored resource type. The type must be defined in the [Service.monitored_resources][google.api.Service.monitored_resources] section.
- Logging_LoggingDestination::setLogs() — Method in class Logging_LoggingDestination
- Names of the logs to be sent to this destination. Each name must be defined in the [Service.logs][google.api.Service.logs] section. If the log name is not a domain scoped name, it will be automatically prefixed with the service name followed by "/".
- Metric::setType() — Method in class Metric
- An existing metric type, see [google.api.MetricDescriptor][google.api.MetricDescriptor].
- Metric::setLabels() — Method in class Metric
- The set of label values that uniquely identify this metric. All
labels listed in the
MetricDescriptormust be assigned values. - MetricDescriptor::setName() — Method in class MetricDescriptor
- The resource name of the metric descriptor. Depending on the
implementation, the name typically includes: (1) the parent resource name
that defines the scope of the metric type or of its data; and (2) the
metric's URL-encoded type, which also appears in the
typefield of this descriptor. For example, following is the resource name of a custom metric within the GCP projectmy-project-id: "projects/my-project-id/metricDescriptors/custom.googleapis.com%2Finvoice%2Fpaid%2Famount" - MetricDescriptor::setType() — Method in class MetricDescriptor
- The metric type, including its DNS name prefix. The type is not
URL-encoded. All user-defined custom metric types have the DNS name
custom.googleapis.com. Metric types should use a natural hierarchical grouping. For example: "custom.googleapis.com/invoice/paid/amount" "appengine.googleapis.com/http/server/response_latencies" - MetricDescriptor::setLabels() — Method in class MetricDescriptor
- The set of labels that can be used to describe a specific
instance of this metric type. For example, the
appengine.googleapis.com/http/server/response_latenciesmetric type has a label for the HTTP response code,response_code, so you can look at latencies for successful responses or just for responses that failed. - MetricDescriptor::setMetricKind() — Method in class MetricDescriptor
- Whether the metric records instantaneous values, changes to a value, etc.
- MetricDescriptor::setValueType() — Method in class MetricDescriptor
- Whether the measurement is an integer, a floating-point number, etc.
- MetricDescriptor::setUnit() — Method in class MetricDescriptor
- The unit in which the metric value is reported. It is only applicable
if the
value_typeisINT64,DOUBLE, orDISTRIBUTION. The supported units are a subset of The Unified Code for Units of Measure standard: Basic units (UNIT) *bitbit *Bybyte *ssecond *minminute *hhour *dday Prefixes (PREFIX) *kkilo (103) *Mmega (106) *Ggiga (109) *Ttera (1012) *Ppeta (1015) *Eexa (1018) *Zzetta (1021) *Yyotta (1024) *mmilli (10-3) *umicro (10-6) *nnano (10-9) *ppico (10-12) *ffemto (10-15) *aatto (10-18) *zzepto (10-21) *yyocto (10-24) *Kikibi (210) *Mimebi (220) *Gigibi (230) *Titebi (240) Grammar The grammar includes the dimensionless unit1, such as1/s. - MetricDescriptor::setDescription() — Method in class MetricDescriptor
- A detailed description of the metric, which can be used in documentation.
- MetricDescriptor::setDisplayName() — Method in class MetricDescriptor
- A concise name for the metric, which can be displayed in user interfaces.
- MetricRule::setSelector() — Method in class MetricRule
- Selects the methods to which this rule applies.
- MetricRule::setMetricCosts() — Method in class MetricRule
- Metrics to update when the selected methods are called, and the associated cost applied to each metric.
- MonitoredResource::setType() — Method in class MonitoredResource
- Required. The monitored resource type. This field must match
the
typefield of a [MonitoredResourceDescriptor][google.api.MonitoredResourceDescriptor] object. For example, the type of a Cloud SQL database is"cloudsql_database". - MonitoredResource::setLabels() — Method in class MonitoredResource
- Required. Values for all of the labels listed in the associated monitored
resource descriptor. For example, Cloud SQL databases use the labels
"database_id"and"zone". - MonitoredResourceDescriptor::setName() — Method in class MonitoredResourceDescriptor
- Optional. The resource name of the monitored resource descriptor:
"projects/{project_id}/monitoredResourceDescriptors/{type}"where {type} is the value of thetypefield in this object and {project_id} is a project ID that provides API-specific context for accessing the type. APIs that do not use project information can use the resource name format"monitoredResourceDescriptors/{type}". - MonitoredResourceDescriptor::setType() — Method in class MonitoredResourceDescriptor
- Required. The monitored resource type. For example, the type
"cloudsql_database"represents databases in Google Cloud SQL. - MonitoredResourceDescriptor::setDisplayName() — Method in class MonitoredResourceDescriptor
- Optional. A concise name for the monitored resource type that might be
displayed in user interfaces. It should be a Title Cased Noun Phrase,
without any article or other determiners. For example,
"Google Cloud SQL Database". - MonitoredResourceDescriptor::setDescription() — Method in class MonitoredResourceDescriptor
- Optional. A detailed description of the monitored resource type that might be used in documentation.
- MonitoredResourceDescriptor::setLabels() — Method in class MonitoredResourceDescriptor
- Required. A set of labels used to describe instances of this monitored
resource type. For example, an individual Google Cloud SQL database is
identified by values for the labels
"database_id"and"zone". - Monitoring::setProducerDestinations() — Method in class Monitoring
- Monitoring configurations for sending metrics to the producer project.
- Monitoring::setConsumerDestinations() — Method in class Monitoring
- Monitoring configurations for sending metrics to the consumer project.
- Monitoring_MonitoringDestination::setMonitoredResource() — Method in class Monitoring_MonitoringDestination
- The monitored resource type. The type must be defined in [Service.monitored_resources][google.api.Service.monitored_resources] section.
- Monitoring_MonitoringDestination::setMetrics() — Method in class Monitoring_MonitoringDestination
- Names of the metrics to report to this monitoring destination.
- OAuthRequirements::setCanonicalScopes() — Method in class OAuthRequirements
- The list of publicly documented OAuth scopes that are allowed access. An OAuth token containing any of these scopes will be accepted.
- Page::setName() — Method in class Page
- The name of the page. It will be used as an identity of the page to
generate URI of the page, text of the link to this page in navigation,
etc. The full page name (start from the root page name to this page
concatenated with
.) can be used as reference to the page in your documentation. For example:pages: - name: Tutorial content: (== include tutorial.md ==) subpages: - name: Java content: (== include tutorial_java.md ==)You can reference
Javapage using Markdown reference link syntax:[Java][Tutorial.Java]. - Page::setContent() — Method in class Page
- The Markdown content of the page. You can use
(== include {path} ==)to include content from a Markdown file. - Page::setSubpages() — Method in class Page
- Subpages of this page. The order of subpages specified here will be honored in the generated docset.
- ProjectProperties::setProperties() — Method in class ProjectProperties
- List of per consumer project-specific properties.
- Property::setName() — Method in class Property
- The name of the property (a.k.a key).
- Property::setType() — Method in class Property
- The type of this property.
- Property::setDescription() — Method in class Property
- The description of the property
- Quota::setLimits() — Method in class Quota
- List of
QuotaLimitdefinitions for the service. - Quota::setMetricRules() — Method in class Quota
- List of
MetricRuledefinitions, each one mapping a selected method to one or more metrics. - QuotaLimit::setName() — Method in class QuotaLimit
- Name of the quota limit. The name is used to refer to the limit when overriding the default limit on per-consumer basis.
- QuotaLimit::setDescription() — Method in class QuotaLimit
- Optional. User-visible, extended description for this quota limit.
- QuotaLimit::setDefaultLimit() — Method in class QuotaLimit
- Default number of tokens that can be consumed during the specified duration. This is the number of tokens assigned when a client application developer activates the service for his/her project.
- QuotaLimit::setMaxLimit() — Method in class QuotaLimit
- Maximum number of tokens that can be consumed during the specified duration. Client application developers can override the default limit up to this maximum. If specified, this value cannot be set to a value less than the default limit. If not specified, it is set to the default limit.
- QuotaLimit::setFreeTier() — Method in class QuotaLimit
- Free tier value displayed in the Developers Console for this limit.
- QuotaLimit::setDuration() — Method in class QuotaLimit
- Duration of this limit in textual notation. Example: "100s", "24h", "1d".
- QuotaLimit::setMetric() — Method in class QuotaLimit
- The name of the metric this quota limit applies to. The quota limits with the same metric will be checked together during runtime. The metric must be defined within the service config.
- QuotaLimit::setUnit() — Method in class QuotaLimit
- Specify the unit of the quota limit. It uses the same syntax as [Metric.unit][]. The supported unit kinds are determined by the quota backend system.
- QuotaLimit::setValues() — Method in class QuotaLimit
- Tiered limit values. Also allows for regional or zone overrides for these values if "/{region}" or "/{zone}" is specified in the unit field.
- QuotaLimit::setDisplayName() — Method in class QuotaLimit
- User-visible display name for this limit.
- Service — Class in namespace Google\Api
Serviceis the root object of Google service configuration schema. It describes basic information about a service, such as the name and the title, and delegates other aspects to sub-sections. Each sub-section is either a proto message or a repeated proto message that configures a specific aspect, such as auth. See each proto message definition for details.- Service::setConfigVersion() — Method in class Service
- The semantic version of the service configuration. The config version affects the interpretation of the service configuration. For example, certain features are enabled by default for certain config versions.
- Service::setName() — Method in class Service
- The DNS address at which this service is available,
e.g.
calendar.googleapis.com. - Service::setId() — Method in class Service
- A unique ID for a specific instance of this message, typically assigned by the client for tracking purpose. If empty, the server may choose to generate one instead.
- Service::setTitle() — Method in class Service
- The product title for this service.
- Service::setProducerProjectId() — Method in class Service
- The Google project that owns this service.
- Service::setApis() — Method in class Service
- A list of API interfaces exported by this service. Only the
namefield of the [google.protobuf.Api][google.protobuf.Api] needs to be provided by the configuration author, as the remaining fields will be derived from the IDL during the normalization process. It is an error to specify an API interface here which cannot be resolved against the associated IDL files. - Service::setTypes() — Method in class Service
- A list of all proto message types included in this API service.
- Service::setEnums() — Method in class Service
- A list of all enum types included in this API service. Enums
referenced directly or indirectly by the
apisare automatically included. Enums which are not referenced but shall be included should be listed here by name. Example: enums: - name: google.someapi.v1.SomeEnum - Service::setDocumentation() — Method in class Service
- Additional API documentation.
- Service::setBackend() — Method in class Service
- API backend configuration.
- Service::setHttp() — Method in class Service
- HTTP configuration.
- Service::setQuota() — Method in class Service
- Quota configuration.
- Service::setAuthentication() — Method in class Service
- Auth configuration.
- Service::setContext() — Method in class Service
- Context configuration.
- Service::setUsage() — Method in class Service
- Configuration controlling usage of this service.
- Service::setEndpoints() — Method in class Service
- Configuration for network endpoints. If this is empty, then an endpoint with the same name as the service is automatically generated to service all defined APIs.
- Service::setControl() — Method in class Service
- Configuration for the service control plane.
- Service::setLogs() — Method in class Service
- Defines the logs used by this service.
- Service::setMetrics() — Method in class Service
- Defines the metrics used by this service.
- Service::setMonitoredResources() — Method in class Service
- Defines the monitored resources used by this service. This is required by the [Service.monitoring][google.api.Service.monitoring] and [Service.logging][google.api.Service.logging] configurations.
- Service::setBilling() — Method in class Service
- Billing configuration.
- Service::setLogging() — Method in class Service
- Logging configuration.
- Service::setMonitoring() — Method in class Service
- Monitoring configuration.
- Service::setSystemParameters() — Method in class Service
- System parameter configuration.
- Service::setSourceInfo() — Method in class Service
- Output only. The source information for this configuration if available.
- Service::setExperimental() — Method in class Service
- Experimental configuration.
- SourceInfo — Class in namespace Google\Api
- Source information used to create a Service Config
- SourceInfo::setSourceFiles() — Method in class SourceInfo
- All files used during config generation.
- SystemParameter — Class in namespace Google\Api
- Define a parameter's name and location. The parameter may be passed as either an HTTP header or a URL query parameter, and if both are passed the behavior is implementation-dependent.
- SystemParameter::setName() — Method in class SystemParameter
- Define the name of the parameter, such as "api_key" . It is case sensitive.
- SystemParameter::setHttpHeader() — Method in class SystemParameter
- Define the HTTP header name to use for the parameter. It is case insensitive.
- SystemParameter::setUrlQueryParameter() — Method in class SystemParameter
- Define the URL query parameter name to use for the parameter. It is case sensitive.
- SystemParameterRule — Class in namespace Google\Api
- Define a system parameter rule mapping system parameter definitions to methods.
- SystemParameterRule::setSelector() — Method in class SystemParameterRule
- Selects the methods to which this rule applies. Use '*' to indicate all methods in all APIs.
- SystemParameterRule::setParameters() — Method in class SystemParameterRule
- Define parameters. Multiple names may be defined for a parameter.
- SystemParameters — Class in namespace Google\Api
System parameter configuration
A system parameter is a special kind of parameter defined by the API system, not by an individual API. It is typically mapped to an HTTP header and/or a URL query parameter. This configuration specifies which methods change the names of the system parameters.
- SystemParameters::setRules() — Method in class SystemParameters
- Define system parameters.
- Usage::setRequirements() — Method in class Usage
- Requirements that must be satisfied before a consumer project can use the
service. Each requirement is of the form <service.name>/
; for example 'serviceusage.googleapis.com/billing-enabled'. - Usage::setRules() — Method in class Usage
- A list of usage rules that apply to individual API methods.
- Usage::setProducerNotificationChannel() — Method in class Usage
- The full resource name of a channel used for sending notifications to the service producer.
- UsageRule::setSelector() — Method in class UsageRule
- Selects the methods to which this rule applies. Use '*' to indicate all methods in all APIs.
- UsageRule::setAllowUnregisteredCalls() — Method in class UsageRule
- True, if the method allows unregistered calls; false otherwise.
- UsageRule::setSkipServiceControl() — Method in class UsageRule
- True, if the method should skip service control. If so, no control plane feature (like quota and billing) will be enabled.
- AuditLog::setServiceName() — Method in class AuditLog
- The name of the API service performing the operation. For example,
"datastore.googleapis.com". - AuditLog::setMethodName() — Method in class AuditLog
- The name of the service method or operation.
- AuditLog::setResourceName() — Method in class AuditLog
- The resource or collection that is the target of the operation.
- AuditLog::setNumResponseItems() — Method in class AuditLog
- The number of items returned from a List or Query API method, if applicable.
- AuditLog::setStatus() — Method in class AuditLog
- The status of the overall operation.
- AuditLog::setAuthenticationInfo() — Method in class AuditLog
- Authentication information.
- AuditLog::setAuthorizationInfo() — Method in class AuditLog
- Authorization information. If there are multiple resources or permissions involved, then there is one AuthorizationInfo element for each {resource, permission} tuple.
- AuditLog::setRequestMetadata() — Method in class AuditLog
- Metadata about the operation.
- AuditLog::setRequest() — Method in class AuditLog
- The operation request. This may not include all request parameters, such as those that are too large, privacy-sensitive, or duplicated elsewhere in the log record.
- AuditLog::setResponse() — Method in class AuditLog
- The operation response. This may not include all response elements, such as those that are too large, privacy-sensitive, or duplicated elsewhere in the log record.
- AuditLog::setServiceData() — Method in class AuditLog
- Other service-specific data about the request, response, and other activities.
- AuthenticationInfo::setPrincipalEmail() — Method in class AuthenticationInfo
- The email address of the authenticated user making the request.
- AuthorizationInfo::setResource() — Method in class AuthorizationInfo
- The resource being accessed, as a REST-style string. For example: bigquery.googlapis.com/projects/PROJECTID/datasets/DATASETID
- AuthorizationInfo::setPermission() — Method in class AuthorizationInfo
- The required IAM permission.
- AuthorizationInfo::setGranted() — Method in class AuthorizationInfo
- Whether or not authorization for
resourceandpermissionwas granted. - RequestMetadata::setCallerIp() — Method in class RequestMetadata
- The IP address of the caller.
- RequestMetadata::setCallerSuppliedUserAgent() — Method in class RequestMetadata
- The user agent of the caller.
- CheckValidCredsRequest::setName() — Method in class CheckValidCredsRequest
- The data source in the form:
projects/{project_id}/dataSources/{data_source_id} - CheckValidCredsResponse::setHasValidCreds() — Method in class CheckValidCredsResponse
- If set to
true, the credentials exist and are valid. - CreateTransferConfigRequest::setParent() — Method in class CreateTransferConfigRequest
- The BigQuery project id where the transfer configuration should be created.
- CreateTransferConfigRequest::setTransferConfig() — Method in class CreateTransferConfigRequest
- Data transfer configuration to create.
- CreateTransferConfigRequest::setAuthorizationCode() — Method in class CreateTransferConfigRequest
- Optional OAuth2 authorization code to use with this transfer configuration.
- DataSource::setName() — Method in class DataSource
- Output only. Data source resource name.
- DataSource::setDataSourceId() — Method in class DataSource
- Data source id.
- DataSource::setDisplayName() — Method in class DataSource
- User friendly data source name.
- DataSource::setDescription() — Method in class DataSource
- User friendly data source description string.
- DataSource::setClientId() — Method in class DataSource
- Data source client id which should be used to receive refresh token.
- DataSource::setScopes() — Method in class DataSource
- Api auth scopes for which refresh token needs to be obtained. Only valid
when
client_idis specified. Ignored otherwise. These are scopes needed by a data source to prepare data and ingest them into BigQuery, e.g., https://www.googleapis.com/auth/bigquery - DataSource::setTransferType() — Method in class DataSource
- Deprecated. This field has no effect.
- DataSource::setSupportsMultipleTransfers() — Method in class DataSource
- Indicates whether the data source supports multiple transfers to different BigQuery targets.
- DataSource::setUpdateDeadlineSeconds() — Method in class DataSource
- The number of seconds to wait for an update from the data source before BigQuery marks the transfer as failed.
- DataSource::setDefaultSchedule() — Method in class DataSource
- Default data transfer schedule.
- DataSource::setSupportsCustomSchedule() — Method in class DataSource
- Specifies whether the data source supports a user defined schedule, or operates on the default schedule.
- DataSource::setParameters() — Method in class DataSource
- Data source parameters.
- DataSource::setHelpUrl() — Method in class DataSource
- Url for the help document for this data source.
- DataSource::setAuthorizationType() — Method in class DataSource
- Indicates the type of authorization.
- DataSource::setDataRefreshType() — Method in class DataSource
- Specifies whether the data source supports automatic data refresh for the past few days, and how it's supported.
- DataSource::setDefaultDataRefreshWindowDays() — Method in class DataSource
- Default data refresh window on days.
- DataSource::setManualRunsDisabled() — Method in class DataSource
- Disables backfilling and manual run scheduling for the data source.
- DataSource::setMinimumScheduleInterval() — Method in class DataSource
- The minimum interval for scheduler to schedule runs.
- DataSourceParameter::setParamId() — Method in class DataSourceParameter
- Parameter identifier.
- DataSourceParameter::setDisplayName() — Method in class DataSourceParameter
- Parameter display name in the user interface.
- DataSourceParameter::setDescription() — Method in class DataSourceParameter
- Parameter description.
- DataSourceParameter::setType() — Method in class DataSourceParameter
- Parameter type.
- DataSourceParameter::setRequired() — Method in class DataSourceParameter
- Is parameter required.
- DataSourceParameter::setRepeated() — Method in class DataSourceParameter
- Can parameter have multiple values.
- DataSourceParameter::setValidationRegex() — Method in class DataSourceParameter
- Regular expression which can be used for parameter validation.
- DataSourceParameter::setAllowedValues() — Method in class DataSourceParameter
- All possible values for the parameter.
- DataSourceParameter::setMinValue() — Method in class DataSourceParameter
- For integer and double values specifies minimum allowed value.
- DataSourceParameter::setMaxValue() — Method in class DataSourceParameter
- For integer and double values specifies maxminum allowed value.
- DataSourceParameter::setFields() — Method in class DataSourceParameter
- When parameter is a record, describes child fields.
- DataSourceParameter::setValidationDescription() — Method in class DataSourceParameter
- Description of the requirements for this field, in case the user input does not fulfill the regex pattern or min/max values.
- DataSourceParameter::setValidationHelpUrl() — Method in class DataSourceParameter
- URL to a help document to further explain the naming requirements.
- DataSourceParameter::setImmutable() — Method in class DataSourceParameter
- Cannot be changed after initial creation.
- DataSourceParameter::setRecurse() — Method in class DataSourceParameter
- If set to true, schema should be taken from the parent with the same parameter_id. Only applicable when parameter type is RECORD.
- DataTransferServiceGrpcClient::ScheduleTransferRuns() — Method in class DataTransferServiceGrpcClient
- Creates transfer runs for a time range [start_time, end_time].
- DeleteTransferConfigRequest::setName() — Method in class DeleteTransferConfigRequest
- The field will contain name of the resource requested, for example:
projects/{project_id}/transferConfigs/{config_id} - DeleteTransferRunRequest::setName() — Method in class DeleteTransferRunRequest
- The field will contain name of the resource requested, for example:
projects/{project_id}/transferConfigs/{config_id}/runs/{run_id} - GetDataSourceRequest::setName() — Method in class GetDataSourceRequest
- The field will contain name of the resource requested, for example:
projects/{project_id}/dataSources/{data_source_id} - GetTransferConfigRequest::setName() — Method in class GetTransferConfigRequest
- The field will contain name of the resource requested, for example:
projects/{project_id}/transferConfigs/{config_id} - GetTransferRunRequest::setName() — Method in class GetTransferRunRequest
- The field will contain name of the resource requested, for example:
projects/{project_id}/transferConfigs/{config_id}/runs/{run_id} - ListDataSourcesRequest::setParent() — Method in class ListDataSourcesRequest
- The BigQuery project id for which data sources should be returned.
- ListDataSourcesRequest::setPageToken() — Method in class ListDataSourcesRequest
- Pagination token, which can be used to request a specific page
of
ListDataSourcesRequestlist results. For multiple-page results,ListDataSourcesResponseoutputs anext_pagetoken, which can be used as thepage_tokenvalue to request the next page of list results. - ListDataSourcesRequest::setPageSize() — Method in class ListDataSourcesRequest
- Page size. The default page size is the maximum value of 1000 results.
- ListDataSourcesResponse::setDataSources() — Method in class ListDataSourcesResponse
- List of supported data sources and their transfer settings.
- ListDataSourcesResponse::setNextPageToken() — Method in class ListDataSourcesResponse
- Output only. The next-pagination token. For multiple-page list results,
this token can be used as the
ListDataSourcesRequest.page_tokento request the next page of list results. - ListTransferConfigsRequest::setParent() — Method in class ListTransferConfigsRequest
- The BigQuery project id for which data sources
should be returned:
projects/{project_id}. - ListTransferConfigsRequest::setDataSourceIds() — Method in class ListTransferConfigsRequest
- When specified, only configurations of requested data sources are returned.
- ListTransferConfigsRequest::setPageToken() — Method in class ListTransferConfigsRequest
- Pagination token, which can be used to request a specific page
of
ListTransfersRequestlist results. For multiple-page results,ListTransfersResponseoutputs anext_pagetoken, which can be used as thepage_tokenvalue to request the next page of list results. - ListTransferConfigsRequest::setPageSize() — Method in class ListTransferConfigsRequest
- Page size. The default page size is the maximum value of 1000 results.
- ListTransferConfigsResponse::setTransferConfigs() — Method in class ListTransferConfigsResponse
- Output only. The stored pipeline transfer configurations.
- ListTransferConfigsResponse::setNextPageToken() — Method in class ListTransferConfigsResponse
- Output only. The next-pagination token. For multiple-page list results,
this token can be used as the
ListTransferConfigsRequest.page_tokento request the next page of list results. - ListTransferLogsRequest::setParent() — Method in class ListTransferLogsRequest
- Transfer run name in the form:
projects/{project_id}/transferConfigs/{config_Id}/runs/{run_id}. - ListTransferLogsRequest::setPageToken() — Method in class ListTransferLogsRequest
- Pagination token, which can be used to request a specific page
of
ListTransferLogsRequestlist results. For multiple-page results,ListTransferLogsResponseoutputs anext_pagetoken, which can be used as thepage_tokenvalue to request the next page of list results. - ListTransferLogsRequest::setPageSize() — Method in class ListTransferLogsRequest
- Page size. The default page size is the maximum value of 1000 results.
- ListTransferLogsRequest::setMessageTypes() — Method in class ListTransferLogsRequest
- Message types to return. If not populated - INFO, WARNING and ERROR messages are returned.
- ListTransferLogsResponse::setTransferMessages() — Method in class ListTransferLogsResponse
- Output only. The stored pipeline transfer messages.
- ListTransferLogsResponse::setNextPageToken() — Method in class ListTransferLogsResponse
- Output only. The next-pagination token. For multiple-page list results,
this token can be used as the
GetTransferRunLogRequest.page_tokento request the next page of list results. - ListTransferRunsRequest::setParent() — Method in class ListTransferRunsRequest
- Name of transfer configuration for which transfer runs should be retrieved.
- ListTransferRunsRequest::setStates() — Method in class ListTransferRunsRequest
- When specified, only transfer runs with requested states are returned.
- ListTransferRunsRequest::setPageToken() — Method in class ListTransferRunsRequest
- Pagination token, which can be used to request a specific page
of
ListTransferRunsRequestlist results. For multiple-page results,ListTransferRunsResponseoutputs anext_pagetoken, which can be used as thepage_tokenvalue to request the next page of list results. - ListTransferRunsRequest::setPageSize() — Method in class ListTransferRunsRequest
- Page size. The default page size is the maximum value of 1000 results.
- ListTransferRunsRequest::setRunAttempt() — Method in class ListTransferRunsRequest
- Indicates how run attempts are to be pulled.
- ListTransferRunsResponse::setTransferRuns() — Method in class ListTransferRunsResponse
- Output only. The stored pipeline transfer runs.
- ListTransferRunsResponse::setNextPageToken() — Method in class ListTransferRunsResponse
- Output only. The next-pagination token. For multiple-page list results,
this token can be used as the
ListTransferRunsRequest.page_tokento request the next page of list results. - ScheduleTransferRunsRequest — Class in namespace Google\Cloud\BigQuery\DataTransfer\V1
- A request to schedule transfer runs for a time range.
- ScheduleTransferRunsRequest::setParent() — Method in class ScheduleTransferRunsRequest
- Transfer configuration name in the form:
projects/{project_id}/transferConfigs/{config_id}. - ScheduleTransferRunsRequest::setStartTime() — Method in class ScheduleTransferRunsRequest
- Start time of the range of transfer runs. For example,
"2017-05-25T00:00:00+00:00". - ScheduleTransferRunsRequest::setEndTime() — Method in class ScheduleTransferRunsRequest
- End time of the range of transfer runs. For example,
"2017-05-30T00:00:00+00:00". - ScheduleTransferRunsResponse — Class in namespace Google\Cloud\BigQuery\DataTransfer\V1
- A response to schedule transfer runs for a time range.
- ScheduleTransferRunsResponse::setRuns() — Method in class ScheduleTransferRunsResponse
- The transfer runs that were scheduled.
- TransferConfig::setName() — Method in class TransferConfig
- The resource name of the transfer config.
- TransferConfig::setDestinationDatasetId() — Method in class TransferConfig
- The BigQuery target dataset id.
- TransferConfig::setDisplayName() — Method in class TransferConfig
- User specified display name for the data transfer.
- TransferConfig::setDataSourceId() — Method in class TransferConfig
- Data source id. Cannot be changed once data transfer is created.
- TransferConfig::setParams() — Method in class TransferConfig
- Data transfer specific parameters.
- TransferConfig::setSchedule() — Method in class TransferConfig
- Data transfer schedule.
- TransferConfig::setDataRefreshWindowDays() — Method in class TransferConfig
- The number of days to look back to automatically refresh the data.
- TransferConfig::setDisabled() — Method in class TransferConfig
- Is this config disabled. When set to true, no runs are scheduled for a given transfer.
- TransferConfig::setUpdateTime() — Method in class TransferConfig
- Output only. Data transfer modification time. Ignored by server on input.
- TransferConfig::setNextRunTime() — Method in class TransferConfig
- Output only. Next time when data transfer will run.
- TransferConfig::setState() — Method in class TransferConfig
- Output only. State of the most recently updated transfer run.
- TransferConfig::setUserId() — Method in class TransferConfig
- Output only. Unique ID of the user on whose behalf transfer is done.
- TransferConfig::setDatasetRegion() — Method in class TransferConfig
- Output only. Region in which BigQuery dataset is located.
- TransferMessage::setMessageTime() — Method in class TransferMessage
- Time when message was logged.
- TransferMessage::setSeverity() — Method in class TransferMessage
- Message severity.
- TransferMessage::setMessageText() — Method in class TransferMessage
- Message text.
- TransferRun::setName() — Method in class TransferRun
- The resource name of the transfer run.
- TransferRun::setScheduleTime() — Method in class TransferRun
- Minimum time after which a transfer run can be started.
- TransferRun::setRunTime() — Method in class TransferRun
- For batch transfer runs, specifies the date and time that data should be ingested.
- TransferRun::setErrorStatus() — Method in class TransferRun
- Status of the transfer run.
- TransferRun::setStartTime() — Method in class TransferRun
- Output only. Time when transfer run was started.
- TransferRun::setEndTime() — Method in class TransferRun
- Output only. Time when transfer run ended.
- TransferRun::setUpdateTime() — Method in class TransferRun
- Output only. Last time the data transfer run state was updated.
- TransferRun::setParams() — Method in class TransferRun
- Output only. Data transfer specific parameters.
- TransferRun::setDestinationDatasetId() — Method in class TransferRun
- Output only. The BigQuery target dataset id.
- TransferRun::setDataSourceId() — Method in class TransferRun
- Output only. Data source id.
- TransferRun::setState() — Method in class TransferRun
- Data transfer run state. Ignored for input requests.
- TransferRun::setUserId() — Method in class TransferRun
- Output only. Unique ID of the user on whose behalf transfer is done.
- TransferRun::setSchedule() — Method in class TransferRun
- Output only. Describes the schedule of this transfer run if it was created as part of a regular schedule. For batch transfer runs that are scheduled manually, this is empty.
- UpdateTransferConfigRequest::setTransferConfig() — Method in class UpdateTransferConfigRequest
- Data transfer configuration to create.
- UpdateTransferConfigRequest::setAuthorizationCode() — Method in class UpdateTransferConfigRequest
- Optional OAuth2 authorization code to use with this transfer configuration.
- UpdateTransferConfigRequest::setUpdateMask() — Method in class UpdateTransferConfigRequest
- Required list of fields to be updated in this request.
- AppProfile::setName() — Method in class AppProfile
- (
OutputOnly) The unique name of the app profile. Values are of the formprojects/<project>/instances/<instance>/appProfiles/[_a-zA-Z0-9][-_.a-zA-Z0-9]*. - AppProfile::setEtag() — Method in class AppProfile
- Strongly validated etag for optimistic concurrency control. Preserve the
value returned from
GetAppProfilewhen callingUpdateAppProfileto fail the request if there has been a modification in the mean time. Theupdate_maskof the request need not includeetagfor this protection to apply. - AppProfile::setDescription() — Method in class AppProfile
- Optional long form description of the use case for this AppProfile.
- AppProfile::setMultiClusterRoutingUseAny() — Method in class AppProfile
- Use a multi-cluster routing policy that may pick any cluster.
- AppProfile::setSingleClusterRouting() — Method in class AppProfile
- Use a single-cluster routing policy.
- AppProfile_SingleClusterRouting::setClusterId() — Method in class AppProfile_SingleClusterRouting
- The cluster to which read/write requests should be routed.
- AppProfile_SingleClusterRouting::setAllowTransactionalWrites() — Method in class AppProfile_SingleClusterRouting
- Whether or not
CheckAndMutateRowandReadModifyWriteRowrequests are allowed by this app profile. It is unsafe to send these requests to the same table/row/column in multiple clusters. - BigtableInstanceAdminGrpcClient::SetIamPolicy() — Method in class BigtableInstanceAdminGrpcClient
- Sets the access control policy on an instance resource. Replaces any existing policy.
- BigtableTableAdminGrpcClient::SnapshotTable() — Method in class BigtableTableAdminGrpcClient
- Creates a new snapshot in the specified cluster from the specified source table. The cluster and the table must be in the same instance.
- CheckConsistencyRequest::setName() — Method in class CheckConsistencyRequest
- The unique name of the Table for which to check replication consistency.
- CheckConsistencyRequest::setConsistencyToken() — Method in class CheckConsistencyRequest
- The token created using GenerateConsistencyToken for the Table.
- CheckConsistencyResponse::setConsistent() — Method in class CheckConsistencyResponse
- True only if the token is consistent. A token is consistent if replication has caught up with the restrictions specified in the request.
- Cluster::setName() — Method in class Cluster
- (
OutputOnly) The unique name of the cluster. Values are of the formprojects/<project>/instances/<instance>/clusters/[a-z][-a-z0-9]*. - Cluster::setLocation() — Method in class Cluster
- (
CreationOnly) The location where this cluster's nodes and storage reside. For best performance, clients should be located as close as possible to this cluster. Currently only zones are supported, so values should be of the formprojects/<project>/locations/<zone>. - Cluster::setState() — Method in class Cluster
- (
OutputOnly) The current state of the cluster. - Cluster::setServeNodes() — Method in class Cluster
- The number of nodes allocated to this cluster. More nodes enable higher throughput and more consistent performance.
- Cluster::setDefaultStorageType() — Method in class Cluster
- (
CreationOnly) The type of storage used by this cluster to serve its parent instance's tables, unless explicitly overridden. - ColumnFamily::setGcRule() — Method in class ColumnFamily
- Garbage collection rule specified as a protobuf.
- CreateAppProfileRequest::setParent() — Method in class CreateAppProfileRequest
- The unique name of the instance in which to create the new app profile.
- CreateAppProfileRequest::setAppProfileId() — Method in class CreateAppProfileRequest
- The ID to be used when referring to the new app profile within its
instance, e.g., just
myprofilerather thanprojects/myproject/instances/myinstance/appProfiles/myprofile. - CreateAppProfileRequest::setAppProfile() — Method in class CreateAppProfileRequest
- The app profile to be created.
- CreateAppProfileRequest::setIgnoreWarnings() — Method in class CreateAppProfileRequest
- If true, ignore safety checks when creating the app profile.
- CreateClusterMetadata::setOriginalRequest() — Method in class CreateClusterMetadata
- The request that prompted the initiation of this CreateCluster operation.
- CreateClusterMetadata::setRequestTime() — Method in class CreateClusterMetadata
- The time at which the original request was received.
- CreateClusterMetadata::setFinishTime() — Method in class CreateClusterMetadata
- The time at which the operation failed or was completed successfully.
- CreateClusterRequest::setParent() — Method in class CreateClusterRequest
- The unique name of the instance in which to create the new cluster.
- CreateClusterRequest::setClusterId() — Method in class CreateClusterRequest
- The ID to be used when referring to the new cluster within its instance,
e.g., just
myclusterrather thanprojects/myproject/instances/myinstance/clusters/mycluster. - CreateClusterRequest::setCluster() — Method in class CreateClusterRequest
- The cluster to be created.
- CreateInstanceMetadata::setOriginalRequest() — Method in class CreateInstanceMetadata
- The request that prompted the initiation of this CreateInstance operation.
- CreateInstanceMetadata::setRequestTime() — Method in class CreateInstanceMetadata
- The time at which the original request was received.
- CreateInstanceMetadata::setFinishTime() — Method in class CreateInstanceMetadata
- The time at which the operation failed or was completed successfully.
- CreateInstanceRequest::setParent() — Method in class CreateInstanceRequest
- The unique name of the project in which to create the new instance.
- CreateInstanceRequest::setInstanceId() — Method in class CreateInstanceRequest
- The ID to be used when referring to the new instance within its project,
e.g., just
myinstancerather thanprojects/myproject/instances/myinstance. - CreateInstanceRequest::setInstance() — Method in class CreateInstanceRequest
- The instance to create.
- CreateInstanceRequest::setClusters() — Method in class CreateInstanceRequest
- The clusters to be created within the instance, mapped by desired
cluster ID, e.g., just
myclusterrather thanprojects/myproject/instances/myinstance/clusters/mycluster. - CreateTableFromSnapshotMetadata::setOriginalRequest() — Method in class CreateTableFromSnapshotMetadata
- The request that prompted the initiation of this CreateTableFromSnapshot operation.
- CreateTableFromSnapshotMetadata::setRequestTime() — Method in class CreateTableFromSnapshotMetadata
- The time at which the original request was received.
- CreateTableFromSnapshotMetadata::setFinishTime() — Method in class CreateTableFromSnapshotMetadata
- The time at which the operation failed or was completed successfully.
- CreateTableFromSnapshotRequest::setParent() — Method in class CreateTableFromSnapshotRequest
- The unique name of the instance in which to create the table.
- CreateTableFromSnapshotRequest::setTableId() — Method in class CreateTableFromSnapshotRequest
- The name by which the new table should be referred to within the parent
instance, e.g.,
foobarrather than<parent>/tables/foobar. - CreateTableFromSnapshotRequest::setSourceSnapshot() — Method in class CreateTableFromSnapshotRequest
- The unique name of the snapshot from which to restore the table. The snapshot and the table must be in the same instance.
- CreateTableRequest::setParent() — Method in class CreateTableRequest
- The unique name of the instance in which to create the table.
- CreateTableRequest::setTableId() — Method in class CreateTableRequest
- The name by which the new table should be referred to within the parent
instance, e.g.,
foobarrather than<parent>/tables/foobar. - CreateTableRequest::setTable() — Method in class CreateTableRequest
- The Table to create.
- CreateTableRequest::setInitialSplits() — Method in class CreateTableRequest
- The optional list of row keys that will be used to initially split the table into several tablets (tablets are similar to HBase regions).
- CreateTableRequest_Split::setKey() — Method in class CreateTableRequest_Split
- Row key to use as an initial tablet boundary.
- DeleteAppProfileRequest::setName() — Method in class DeleteAppProfileRequest
- The unique name of the app profile to be deleted. Values are of the form
projects/<project>/instances/<instance>/appProfiles/<app_profile>. - DeleteAppProfileRequest::setIgnoreWarnings() — Method in class DeleteAppProfileRequest
- If true, ignore safety checks when deleting the app profile.
- DeleteClusterRequest::setName() — Method in class DeleteClusterRequest
- The unique name of the cluster to be deleted. Values are of the form
projects/<project>/instances/<instance>/clusters/<cluster>. - DeleteInstanceRequest::setName() — Method in class DeleteInstanceRequest
- The unique name of the instance to be deleted.
- DeleteSnapshotRequest::setName() — Method in class DeleteSnapshotRequest
- The unique name of the snapshot to be deleted.
- DeleteTableRequest::setName() — Method in class DeleteTableRequest
- The unique name of the table to be deleted.
- DropRowRangeRequest::setName() — Method in class DropRowRangeRequest
- The unique name of the table on which to drop a range of rows.
- DropRowRangeRequest::setRowKeyPrefix() — Method in class DropRowRangeRequest
- Delete all rows that start with this row key prefix. Prefix cannot be zero length.
- DropRowRangeRequest::setDeleteAllDataFromTable() — Method in class DropRowRangeRequest
- Delete all rows in the table. Setting this to false is a no-op.
- GcRule::setMaxNumVersions() — Method in class GcRule
- Delete all cells in a column except the most recent N.
- GcRule::setMaxAge() — Method in class GcRule
- Delete cells in a column older than the given age.
- GcRule::setIntersection() — Method in class GcRule
- Delete cells that would be deleted by every nested rule.
- GcRule::setUnion() — Method in class GcRule
- Delete cells that would be deleted by any nested rule.
- GcRule_Intersection::setRules() — Method in class GcRule_Intersection
- Only delete cells which would be deleted by every element of
rules. - GcRule_Union::setRules() — Method in class GcRule_Union
- Delete cells which would be deleted by any element of
rules. - GenerateConsistencyTokenRequest::setName() — Method in class GenerateConsistencyTokenRequest
- The unique name of the Table for which to create a consistency token.
- GenerateConsistencyTokenResponse::setConsistencyToken() — Method in class GenerateConsistencyTokenResponse
- The generated consistency token.
- GetAppProfileRequest::setName() — Method in class GetAppProfileRequest
- The unique name of the requested app profile. Values are of the form
projects/<project>/instances/<instance>/appProfiles/<app_profile>. - GetClusterRequest::setName() — Method in class GetClusterRequest
- The unique name of the requested cluster. Values are of the form
projects/<project>/instances/<instance>/clusters/<cluster>. - GetInstanceRequest::setName() — Method in class GetInstanceRequest
- The unique name of the requested instance. Values are of the form
projects/<project>/instances/<instance>. - GetSnapshotRequest::setName() — Method in class GetSnapshotRequest
- The unique name of the requested snapshot.
- GetTableRequest::setName() — Method in class GetTableRequest
- The unique name of the requested table.
- GetTableRequest::setView() — Method in class GetTableRequest
- The view to be applied to the returned table's fields.
- Instance::setName() — Method in class Instance
- (
OutputOnly) The unique name of the instance. Values are of the formprojects/<project>/instances/[a-z][a-z0-9\\-]+[a-z0-9]. - Instance::setDisplayName() — Method in class Instance
- The descriptive name for this instance as it appears in UIs.
- Instance::setState() — Method in class Instance
- (
OutputOnly) The current state of the instance. - Instance::setType() — Method in class Instance
- The type of the instance. Defaults to
PRODUCTION. - Instance::setLabels() — Method in class Instance
- Labels are a flexible and lightweight mechanism for organizing cloud resources into groups that reflect a customer's organizational needs and deployment strategies. They can be used to filter resources and aggregate metrics.
- ListAppProfilesRequest::setParent() — Method in class ListAppProfilesRequest
- The unique name of the instance for which a list of app profiles is
requested. Values are of the form
projects/<project>/instances/<instance>. - ListAppProfilesRequest::setPageToken() — Method in class ListAppProfilesRequest
- The value of
next_page_tokenreturned by a previous call. - ListAppProfilesResponse::setAppProfiles() — Method in class ListAppProfilesResponse
- The list of requested app profiles.
- ListAppProfilesResponse::setNextPageToken() — Method in class ListAppProfilesResponse
- Set if not all app profiles could be returned in a single response.
- ListClustersRequest::setParent() — Method in class ListClustersRequest
- The unique name of the instance for which a list of clusters is requested.
- ListClustersRequest::setPageToken() — Method in class ListClustersRequest
- The value of
next_page_tokenreturned by a previous call. - ListClustersResponse::setClusters() — Method in class ListClustersResponse
- The list of requested clusters.
- ListClustersResponse::setFailedLocations() — Method in class ListClustersResponse
- Locations from which Cluster information could not be retrieved, due to an outage or some other transient condition.
- ListClustersResponse::setNextPageToken() — Method in class ListClustersResponse
- Set if not all clusters could be returned in a single response.
- ListInstancesRequest::setParent() — Method in class ListInstancesRequest
- The unique name of the project for which a list of instances is requested.
- ListInstancesRequest::setPageToken() — Method in class ListInstancesRequest
- The value of
next_page_tokenreturned by a previous call. - ListInstancesResponse::setInstances() — Method in class ListInstancesResponse
- The list of requested instances.
- ListInstancesResponse::setFailedLocations() — Method in class ListInstancesResponse
- Locations from which Instance information could not be retrieved, due to an outage or some other transient condition.
- ListInstancesResponse::setNextPageToken() — Method in class ListInstancesResponse
- Set if not all instances could be returned in a single response.
- ListSnapshotsRequest::setParent() — Method in class ListSnapshotsRequest
- The unique name of the cluster for which snapshots should be listed.
- ListSnapshotsRequest::setPageSize() — Method in class ListSnapshotsRequest
- The maximum number of snapshots to return.
- ListSnapshotsRequest::setPageToken() — Method in class ListSnapshotsRequest
- The value of
next_page_tokenreturned by a previous call. - ListSnapshotsResponse::setSnapshots() — Method in class ListSnapshotsResponse
- The snapshots present in the requested cluster.
- ListSnapshotsResponse::setNextPageToken() — Method in class ListSnapshotsResponse
- Set if not all snapshots could be returned in a single response.
- ListTablesRequest::setParent() — Method in class ListTablesRequest
- The unique name of the instance for which tables should be listed.
- ListTablesRequest::setView() — Method in class ListTablesRequest
- The view to be applied to the returned tables' fields.
- ListTablesRequest::setPageToken() — Method in class ListTablesRequest
- The value of
next_page_tokenreturned by a previous call. - ListTablesResponse::setTables() — Method in class ListTablesResponse
- The tables present in the requested instance.
- ListTablesResponse::setNextPageToken() — Method in class ListTablesResponse
- Set if not all tables could be returned in a single response.
- ModifyColumnFamiliesRequest::setName() — Method in class ModifyColumnFamiliesRequest
- The unique name of the table whose families should be modified.
- ModifyColumnFamiliesRequest::setModifications() — Method in class ModifyColumnFamiliesRequest
- Modifications to be atomically applied to the specified table's families.
- ModifyColumnFamiliesRequest_Modification::setId() — Method in class ModifyColumnFamiliesRequest_Modification
- The ID of the column family to be modified.
- ModifyColumnFamiliesRequest_Modification::setCreate() — Method in class ModifyColumnFamiliesRequest_Modification
- Create a new column family with the specified schema, or fail if one already exists with the given ID.
- ModifyColumnFamiliesRequest_Modification::setUpdate() — Method in class ModifyColumnFamiliesRequest_Modification
- Update an existing column family to the specified schema, or fail if no column family exists with the given ID.
- ModifyColumnFamiliesRequest_Modification::setDrop() — Method in class ModifyColumnFamiliesRequest_Modification
- Drop (delete) the column family with the given ID, or fail if no such family exists.
- PartialUpdateInstanceRequest::setInstance() — Method in class PartialUpdateInstanceRequest
- The Instance which will (partially) replace the current value.
- PartialUpdateInstanceRequest::setUpdateMask() — Method in class PartialUpdateInstanceRequest
- The subset of Instance fields which should be replaced.
- Snapshot — Class in namespace Google\Cloud\Bigtable\Admin\V2
- A snapshot of a table at a particular time. A snapshot can be used as a checkpoint for data restoration or a data source for a new table.
- Snapshot::setName() — Method in class Snapshot
- (
OutputOnly) The unique name of the snapshot. - Snapshot::setSourceTable() — Method in class Snapshot
- (
OutputOnly) The source table at the time the snapshot was taken. - Snapshot::setDataSizeBytes() — Method in class Snapshot
- (
OutputOnly) The size of the data in the source table at the time the snapshot was taken. In some cases, this value may be computed asynchronously via a background process and a placeholder of 0 will be used in the meantime. - Snapshot::setCreateTime() — Method in class Snapshot
- (
OutputOnly) The time when the snapshot is created. - Snapshot::setDeleteTime() — Method in class Snapshot
- (
OutputOnly) The time when the snapshot will be deleted. The maximum amount of time a snapshot can stay active is 365 days. If 'ttl' is not specified, the default maximum of 365 days will be used. - Snapshot::setState() — Method in class Snapshot
- (
OutputOnly) The current state of the snapshot. - Snapshot::setDescription() — Method in class Snapshot
- (
OutputOnly) Description of the snapshot. - SnapshotTableMetadata — Class in namespace Google\Cloud\Bigtable\Admin\V2
- The metadata for the Operation returned by SnapshotTable.
- SnapshotTableMetadata::setOriginalRequest() — Method in class SnapshotTableMetadata
- The request that prompted the initiation of this SnapshotTable operation.
- SnapshotTableMetadata::setRequestTime() — Method in class SnapshotTableMetadata
- The time at which the original request was received.
- SnapshotTableMetadata::setFinishTime() — Method in class SnapshotTableMetadata
- The time at which the operation failed or was completed successfully.
- SnapshotTableRequest — Class in namespace Google\Cloud\Bigtable\Admin\V2
- Request message for [google.bigtable.admin.v2.BigtableTableAdmin.SnapshotTable][google.bigtable.admin.v2.BigtableTableAdmin.SnapshotTable] Note: This is a private alpha release of Cloud Bigtable snapshots. This feature is not currently available to most Cloud Bigtable customers. This feature might be changed in backward-incompatible ways and is not recommended for production use. It is not subject to any SLA or deprecation policy.
- SnapshotTableRequest::setName() — Method in class SnapshotTableRequest
- The unique name of the table to have the snapshot taken.
- SnapshotTableRequest::setCluster() — Method in class SnapshotTableRequest
- The name of the cluster where the snapshot will be created in.
- SnapshotTableRequest::setSnapshotId() — Method in class SnapshotTableRequest
- The ID by which the new snapshot should be referred to within the parent
cluster, e.g.,
mysnapshotof the form:[_a-zA-Z0-9][-_.a-zA-Z0-9]*rather thanprojects/<project>/instances/<instance>/clusters/<cluster>/snapshots/mysnapshot. - SnapshotTableRequest::setTtl() — Method in class SnapshotTableRequest
- The amount of time that the new snapshot can stay active after it is created. Once 'ttl' expires, the snapshot will get deleted. The maximum amount of time a snapshot can stay active is 7 days. If 'ttl' is not specified, the default value of 24 hours will be used.
- SnapshotTableRequest::setDescription() — Method in class SnapshotTableRequest
- Description of the snapshot.
- Snapshot_State — Class in namespace Google\Cloud\Bigtable\Admin\V2
- Possible states of a snapshot.
- StorageType — Class in namespace Google\Cloud\Bigtable\Admin\V2
- Storage media types for persisting Bigtable data.
- Table::setName() — Method in class Table
- (
OutputOnly) The unique name of the table. Values are of the formprojects/<project>/instances/<instance>/tables/[_a-zA-Z0-9][-_.a-zA-Z0-9]*. - Table::setClusterStates() — Method in class Table
- (
OutputOnly) Map from cluster ID to per-cluster table state. - Table::setColumnFamilies() — Method in class Table
- (
CreationOnly) The column families configured for this table, mapped by column family ID. - Table::setGranularity() — Method in class Table
- (
CreationOnly) The granularity (i.e.MILLIS) at which timestamps are stored in this table. Timestamps not matching the granularity will be rejected. - Table_ClusterState::setReplicationState() — Method in class Table_ClusterState
- (
OutputOnly) The state of replication for the table in this cluster. - UpdateAppProfileRequest::setAppProfile() — Method in class UpdateAppProfileRequest
- The app profile which will (partially) replace the current value.
- UpdateAppProfileRequest::setUpdateMask() — Method in class UpdateAppProfileRequest
- The subset of app profile fields which should be replaced.
- UpdateAppProfileRequest::setIgnoreWarnings() — Method in class UpdateAppProfileRequest
- If true, ignore safety checks when updating the app profile.
- UpdateClusterMetadata::setOriginalRequest() — Method in class UpdateClusterMetadata
- The request that prompted the initiation of this UpdateCluster operation.
- UpdateClusterMetadata::setRequestTime() — Method in class UpdateClusterMetadata
- The time at which the original request was received.
- UpdateClusterMetadata::setFinishTime() — Method in class UpdateClusterMetadata
- The time at which the operation failed or was completed successfully.
- UpdateInstanceMetadata::setOriginalRequest() — Method in class UpdateInstanceMetadata
- The request that prompted the initiation of this UpdateInstance operation.
- UpdateInstanceMetadata::setRequestTime() — Method in class UpdateInstanceMetadata
- The time at which the original request was received.
- UpdateInstanceMetadata::setFinishTime() — Method in class UpdateInstanceMetadata
- The time at which the operation failed or was completed successfully.
- BigtableGrpcClient::SampleRowKeys() — Method in class BigtableGrpcClient
- Returns a sample of row keys in the table. The returned row keys will delimit contiguous sections of the table of approximately equal size, which can be used to break up the data for distributed tasks like mapreduces.
- Cell::setTimestampMicros() — Method in class Cell
- The cell's stored timestamp, which also uniquely identifies it within its column.
- Cell::setValue() — Method in class Cell
- The value stored in the cell.
- Cell::setLabels() — Method in class Cell
- Labels applied to the cell by a [RowFilter][google.bigtable.v2.RowFilter].
- CheckAndMutateRowRequest::setTableName() — Method in class CheckAndMutateRowRequest
- The unique name of the table to which the conditional mutation should be applied.
- CheckAndMutateRowRequest::setAppProfileId() — Method in class CheckAndMutateRowRequest
- This value specifies routing for replication. If not specified, the "default" application profile will be used.
- CheckAndMutateRowRequest::setRowKey() — Method in class CheckAndMutateRowRequest
- The key of the row to which the conditional mutation should be applied.
- CheckAndMutateRowRequest::setPredicateFilter() — Method in class CheckAndMutateRowRequest
- The filter to be applied to the contents of the specified row. Depending
on whether or not any results are yielded, either
true_mutationsorfalse_mutationswill be executed. If unset, checks that the row contains any values at all. - CheckAndMutateRowRequest::setTrueMutations() — Method in class CheckAndMutateRowRequest
- Changes to be atomically applied to the specified row if
predicate_filteryields at least one cell when applied torow_key. Entries are applied in order, meaning that earlier mutations can be masked by later ones. - CheckAndMutateRowRequest::setFalseMutations() — Method in class CheckAndMutateRowRequest
- Changes to be atomically applied to the specified row if
predicate_filterdoes not yield any cells when applied torow_key. Entries are applied in order, meaning that earlier mutations can be masked by later ones. - CheckAndMutateRowResponse::setPredicateMatched() — Method in class CheckAndMutateRowResponse
- Whether or not the request's
predicate_filteryielded any results for the specified row. - Column::setQualifier() — Method in class Column
- The unique key which identifies this column within its family. This is the
same key that's used to identify the column in, for example, a RowFilter
which sets its
column_qualifier_regex_filterfield. - Column::setCells() — Method in class Column
- Must not be empty. Sorted in order of decreasing "timestamp_micros".
- $ColumnRange#start_qualifier — Property in class ColumnRange
- ColumnRange::setFamilyName() — Method in class ColumnRange
- The name of the column family within which this range falls.
- ColumnRange::setStartQualifierClosed() — Method in class ColumnRange
- Used when giving an inclusive lower bound for the range.
- ColumnRange::setStartQualifierOpen() — Method in class ColumnRange
- Used when giving an exclusive lower bound for the range.
- ColumnRange::setEndQualifierClosed() — Method in class ColumnRange
- Used when giving an inclusive upper bound for the range.
- ColumnRange::setEndQualifierOpen() — Method in class ColumnRange
- Used when giving an exclusive upper bound for the range.
- Family::setName() — Method in class Family
- The unique key which identifies this family within its row. This is the same key that's used to identify the family in, for example, a RowFilter which sets its "family_name_regex_filter" field.
- Family::setColumns() — Method in class Family
- Must not be empty. Sorted in order of increasing "qualifier".
- MutateRowRequest::setTableName() — Method in class MutateRowRequest
- The unique name of the table to which the mutation should be applied.
- MutateRowRequest::setAppProfileId() — Method in class MutateRowRequest
- This value specifies routing for replication. If not specified, the "default" application profile will be used.
- MutateRowRequest::setRowKey() — Method in class MutateRowRequest
- The key of the row to which the mutation should be applied.
- MutateRowRequest::setMutations() — Method in class MutateRowRequest
- Changes to be atomically applied to the specified row. Entries are applied in order, meaning that earlier mutations can be masked by later ones.
- MutateRowsRequest::setTableName() — Method in class MutateRowsRequest
- The unique name of the table to which the mutations should be applied.
- MutateRowsRequest::setAppProfileId() — Method in class MutateRowsRequest
- This value specifies routing for replication. If not specified, the "default" application profile will be used.
- MutateRowsRequest::setEntries() — Method in class MutateRowsRequest
- The row keys and corresponding mutations to be applied in bulk.
- MutateRowsRequest_Entry::setRowKey() — Method in class MutateRowsRequest_Entry
- The key of the row to which the
mutationsshould be applied. - MutateRowsRequest_Entry::setMutations() — Method in class MutateRowsRequest_Entry
- Changes to be atomically applied to the specified row. Mutations are applied in order, meaning that earlier mutations can be masked by later ones.
- MutateRowsResponse::setEntries() — Method in class MutateRowsResponse
- One or more results for Entries from the batch request.
- MutateRowsResponse_Entry::setIndex() — Method in class MutateRowsResponse_Entry
- The index into the original request's
entrieslist of the Entry for which a result is being reported. - MutateRowsResponse_Entry::setStatus() — Method in class MutateRowsResponse_Entry
- The result of the request Entry identified by
index. - Mutation::setSetCell() — Method in class Mutation
- Set a cell's value.
- Mutation::setDeleteFromColumn() — Method in class Mutation
- Deletes cells from a column.
- Mutation::setDeleteFromFamily() — Method in class Mutation
- Deletes cells from a column family.
- Mutation::setDeleteFromRow() — Method in class Mutation
- Deletes cells from the entire row.
- Mutation_DeleteFromColumn::setFamilyName() — Method in class Mutation_DeleteFromColumn
- The name of the family from which cells should be deleted.
- Mutation_DeleteFromColumn::setColumnQualifier() — Method in class Mutation_DeleteFromColumn
- The qualifier of the column from which cells should be deleted.
- Mutation_DeleteFromColumn::setTimeRange() — Method in class Mutation_DeleteFromColumn
- The range of timestamps within which cells should be deleted.
- Mutation_DeleteFromFamily::setFamilyName() — Method in class Mutation_DeleteFromFamily
- The name of the family from which cells should be deleted.
- Mutation_SetCell::setFamilyName() — Method in class Mutation_SetCell
- The name of the family into which new data should be written.
- Mutation_SetCell::setColumnQualifier() — Method in class Mutation_SetCell
- The qualifier of the column into which new data should be written.
- Mutation_SetCell::setTimestampMicros() — Method in class Mutation_SetCell
- The timestamp of the cell into which new data should be written.
- Mutation_SetCell::setValue() — Method in class Mutation_SetCell
- The value to be written into the specified cell.
- ReadModifyWriteRowRequest::setTableName() — Method in class ReadModifyWriteRowRequest
- The unique name of the table to which the read/modify/write rules should be applied.
- ReadModifyWriteRowRequest::setAppProfileId() — Method in class ReadModifyWriteRowRequest
- This value specifies routing for replication. If not specified, the "default" application profile will be used.
- ReadModifyWriteRowRequest::setRowKey() — Method in class ReadModifyWriteRowRequest
- The key of the row to which the read/modify/write rules should be applied.
- ReadModifyWriteRowRequest::setRules() — Method in class ReadModifyWriteRowRequest
- Rules specifying how the specified row's contents are to be transformed into writes. Entries are applied in order, meaning that earlier rules will affect the results of later ones.
- ReadModifyWriteRowResponse::setRow() — Method in class ReadModifyWriteRowResponse
- A Row containing the new contents of all cells modified by the request.
- ReadModifyWriteRule::setFamilyName() — Method in class ReadModifyWriteRule
- The name of the family to which the read/modify/write should be applied.
- ReadModifyWriteRule::setColumnQualifier() — Method in class ReadModifyWriteRule
- The qualifier of the column to which the read/modify/write should be applied.
- ReadModifyWriteRule::setAppendValue() — Method in class ReadModifyWriteRule
- Rule specifying that
append_valuebe appended to the existing value. - ReadModifyWriteRule::setIncrementAmount() — Method in class ReadModifyWriteRule
- Rule specifying that
increment_amountbe added to the existing value. - ReadRowsRequest::setTableName() — Method in class ReadRowsRequest
- The unique name of the table from which to read.
- ReadRowsRequest::setAppProfileId() — Method in class ReadRowsRequest
- This value specifies routing for replication. If not specified, the "default" application profile will be used.
- ReadRowsRequest::setRows() — Method in class ReadRowsRequest
- The row keys and/or ranges to read. If not specified, reads from all rows.
- ReadRowsRequest::setFilter() — Method in class ReadRowsRequest
- The filter to apply to the contents of the specified row(s). If unset, reads the entirety of each row.
- ReadRowsRequest::setRowsLimit() — Method in class ReadRowsRequest
- The read will terminate after committing to N rows' worth of results. The default (zero) is to return all results.
- ReadRowsResponse::setChunks() — Method in class ReadRowsResponse
- Generated from protobuf field
repeated .google.bigtable.v2.ReadRowsResponse.CellChunk chunks = 1; - ReadRowsResponse::setLastScannedRowKey() — Method in class ReadRowsResponse
- Optionally the server might return the row key of the last row it has scanned. The client can use this to construct a more efficient retry request if needed: any row keys or portions of ranges less than this row key can be dropped from the request.
- ReadRowsResponse_CellChunk::setRowKey() — Method in class ReadRowsResponse_CellChunk
- The row key for this chunk of data. If the row key is empty, this CellChunk is a continuation of the same row as the previous CellChunk in the response stream, even if that CellChunk was in a previous ReadRowsResponse message.
- ReadRowsResponse_CellChunk::setFamilyName() — Method in class ReadRowsResponse_CellChunk
- The column family name for this chunk of data. If this message
is not present this CellChunk is a continuation of the same column
family as the previous CellChunk. The empty string can occur as a
column family name in a response so clients must check
explicitly for the presence of this message, not just for
family_name.valuebeing non-empty. - ReadRowsResponse_CellChunk::setQualifier() — Method in class ReadRowsResponse_CellChunk
- The column qualifier for this chunk of data. If this message
is not present, this CellChunk is a continuation of the same column
as the previous CellChunk. Column qualifiers may be empty so
clients must check for the presence of this message, not just
for
qualifier.valuebeing non-empty. - ReadRowsResponse_CellChunk::setTimestampMicros() — Method in class ReadRowsResponse_CellChunk
- The cell's stored timestamp, which also uniquely identifies it
within its column. Values are always expressed in
microseconds, but individual tables may set a coarser
granularity to further restrict the allowed values. For
example, a table which specifies millisecond granularity will
only allow values of
timestamp_microswhich are multiples of 1000. Timestamps are only set in the first CellChunk per cell (for cells split into multiple chunks). - ReadRowsResponse_CellChunk::setLabels() — Method in class ReadRowsResponse_CellChunk
- Labels applied to the cell by a [RowFilter][google.bigtable.v2.RowFilter]. Labels are only set on the first CellChunk per cell.
- ReadRowsResponse_CellChunk::setValue() — Method in class ReadRowsResponse_CellChunk
- The value stored in the cell. Cell values can be split across multiple CellChunks. In that case only the value field will be set in CellChunks after the first: the timestamp and labels will only be present in the first CellChunk, even if the first CellChunk came in a previous ReadRowsResponse.
- ReadRowsResponse_CellChunk::setValueSize() — Method in class ReadRowsResponse_CellChunk
- If this CellChunk is part of a chunked cell value and this is not the final chunk of that cell, value_size will be set to the total length of the cell value. The client can use this size to pre-allocate memory to hold the full cell value.
- ReadRowsResponse_CellChunk::setResetRow() — Method in class ReadRowsResponse_CellChunk
- Indicates that the client should drop all previous chunks for
row_key, as it will be re-read from the beginning. - ReadRowsResponse_CellChunk::setCommitRow() — Method in class ReadRowsResponse_CellChunk
- Indicates that the client can safely process all previous chunks for
row_key, as its data has been fully read. - Row::setKey() — Method in class Row
- The unique key which identifies this row within its table. This is the same key that's used to identify the row in, for example, a MutateRowRequest.
- Row::setFamilies() — Method in class Row
- May be empty, but only if the entire row is empty.
- RowFilter::setChain() — Method in class RowFilter
- Applies several RowFilters to the data in sequence, progressively narrowing the results.
- RowFilter::setInterleave() — Method in class RowFilter
- Applies several RowFilters to the data in parallel and combines the results.
- RowFilter::setCondition() — Method in class RowFilter
- Applies one of two possible RowFilters to the data based on the output of a predicate RowFilter.
- RowFilter::setSink() — Method in class RowFilter
- ADVANCED USE ONLY.
- RowFilter::setPassAllFilter() — Method in class RowFilter
- Matches all cells, regardless of input. Functionally equivalent to
leaving
filterunset, but included for completeness. - RowFilter::setBlockAllFilter() — Method in class RowFilter
- Does not match any cells, regardless of input. Useful for temporarily disabling just part of a filter.
- RowFilter::setRowKeyRegexFilter() — Method in class RowFilter
- Matches only cells from rows whose keys satisfy the given RE2 regex. In other words, passes through the entire row when the key matches, and otherwise produces an empty row.
- RowFilter::setRowSampleFilter() — Method in class RowFilter
- Matches all cells from a row with probability p, and matches no cells from the row with probability 1-p.
- RowFilter::setFamilyNameRegexFilter() — Method in class RowFilter
- Matches only cells from columns whose families satisfy the given RE2
regex. For technical reasons, the regex must not contain the
:character, even if it is not being used as a literal. - RowFilter::setColumnQualifierRegexFilter() — Method in class RowFilter
- Matches only cells from columns whose qualifiers satisfy the given RE2 regex.
- RowFilter::setColumnRangeFilter() — Method in class RowFilter
- Matches only cells from columns within the given range.
- RowFilter::setTimestampRangeFilter() — Method in class RowFilter
- Matches only cells with timestamps within the given range.
- RowFilter::setValueRegexFilter() — Method in class RowFilter
- Matches only cells with values that satisfy the given regular expression.
- RowFilter::setValueRangeFilter() — Method in class RowFilter
- Matches only cells with values that fall within the given range.
- RowFilter::setCellsPerRowOffsetFilter() — Method in class RowFilter
- Skips the first N cells of each row, matching all subsequent cells.
- RowFilter::setCellsPerRowLimitFilter() — Method in class RowFilter
- Matches only the first N cells of each row.
- RowFilter::setCellsPerColumnLimitFilter() — Method in class RowFilter
- Matches only the most recent N cells within each column. For example,
if N=2, this filter would match column
foo:barat timestamps 10 and 9, skip all earlier cells infoo:bar, and then begin matching again in columnfoo:bar2. - RowFilter::setStripValueTransformer() — Method in class RowFilter
- Replaces each cell's value with the empty string.
- RowFilter::setApplyLabelTransformer() — Method in class RowFilter
- Applies the given label to all cells in the output row. This allows the client to determine which results were produced from which part of the filter.
- RowFilter_Chain::setFilters() — Method in class RowFilter_Chain
- The elements of "filters" are chained together to process the input row: in row -> f(0) -> intermediate row -> f(1) -> .
- RowFilter_Condition::setPredicateFilter() — Method in class RowFilter_Condition
- If
predicate_filteroutputs any cells, thentrue_filterwill be evaluated on the input row. Otherwise,false_filterwill be evaluated. - RowFilter_Condition::setTrueFilter() — Method in class RowFilter_Condition
- The filter to apply to the input row if
predicate_filterreturns any results. If not provided, no results will be returned in the true case. - RowFilter_Condition::setFalseFilter() — Method in class RowFilter_Condition
- The filter to apply to the input row if
predicate_filterdoes not return any results. If not provided, no results will be returned in the false case. - RowFilter_Interleave::setFilters() — Method in class RowFilter_Interleave
- The elements of "filters" all process a copy of the input row, and the results are pooled, sorted, and combined into a single output row.
- $RowRange#start_key — Property in class RowRange
- RowRange::setStartKeyClosed() — Method in class RowRange
- Used when giving an inclusive lower bound for the range.
- RowRange::setStartKeyOpen() — Method in class RowRange
- Used when giving an exclusive lower bound for the range.
- RowRange::setEndKeyOpen() — Method in class RowRange
- Used when giving an exclusive upper bound for the range.
- RowRange::setEndKeyClosed() — Method in class RowRange
- Used when giving an inclusive upper bound for the range.
- RowSet::setRowKeys() — Method in class RowSet
- Single rows included in the set.
- RowSet::setRowRanges() — Method in class RowSet
- Contiguous row ranges included in the set.
- SampleRowKeysRequest — Class in namespace Google\Cloud\Bigtable\V2
- Request message for Bigtable.SampleRowKeys.
- SampleRowKeysRequest::setTableName() — Method in class SampleRowKeysRequest
- The unique name of the table from which to sample row keys.
- SampleRowKeysRequest::setAppProfileId() — Method in class SampleRowKeysRequest
- This value specifies routing for replication. If not specified, the "default" application profile will be used.
- SampleRowKeysResponse — Class in namespace Google\Cloud\Bigtable\V2
- Response message for Bigtable.SampleRowKeys.
- SampleRowKeysResponse::setRowKey() — Method in class SampleRowKeysResponse
- Sorted streamed sequence of sample row keys in the table. The table might have contents before the first row key in the list and after the last one, but a key containing the empty string indicates "end of table" and will be the last response given, if present.
- SampleRowKeysResponse::setOffsetBytes() — Method in class SampleRowKeysResponse
- Approximate total storage space used by all rows in the table which precede
row_key. Buffering the contents of all rows between two subsequent samples would require space roughly equal to the difference in theiroffset_bytesfields. - TimestampRange::setStartTimestampMicros() — Method in class TimestampRange
- Inclusive lower bound. If left empty, interpreted as 0.
- TimestampRange::setEndTimestampMicros() — Method in class TimestampRange
- Exclusive upper bound. If left empty, interpreted as infinity.
- $ValueRange#start_value — Property in class ValueRange
- ValueRange::setStartValueClosed() — Method in class ValueRange
- Used when giving an inclusive lower bound for the range.
- ValueRange::setStartValueOpen() — Method in class ValueRange
- Used when giving an exclusive lower bound for the range.
- ValueRange::setEndValueClosed() — Method in class ValueRange
- Used when giving an inclusive upper bound for the range.
- ValueRange::setEndValueOpen() — Method in class ValueRange
- Used when giving an exclusive upper bound for the range.
- AcceleratorConfig::setAcceleratorCount() — Method in class AcceleratorConfig
- The number of the accelerator cards exposed to an instance.
- AcceleratorConfig::setAcceleratorType() — Method in class AcceleratorConfig
- The accelerator type resource name. List of supported accelerators here
- AddonsConfig::setHttpLoadBalancing() — Method in class AddonsConfig
- Configuration for the HTTP (L7) load balancing controller addon, which makes it easy to set up HTTP load balancers for services in a cluster.
- AddonsConfig::setHorizontalPodAutoscaling() — Method in class AddonsConfig
- Configuration for the horizontal pod autoscaling feature, which increases or decreases the number of replica pods a replication controller has based on the resource usage of the existing pods.
- AddonsConfig::setKubernetesDashboard() — Method in class AddonsConfig
- Configuration for the Kubernetes Dashboard.
- AddonsConfig::setNetworkPolicyConfig() — Method in class AddonsConfig
- Configuration for NetworkPolicy. This only tracks whether the addon is enabled or not on the Master, it does not track whether network policy is enabled for the nodes.
- AutoUpgradeOptions::setAutoUpgradeStartTime() — Method in class AutoUpgradeOptions
- [Output only] This field is set when upgrades are about to commence with the approximate start time for the upgrades, in RFC3339 text format.
- AutoUpgradeOptions::setDescription() — Method in class AutoUpgradeOptions
- [Output only] This field is set when upgrades are about to commence with the description of the upgrade.
- CancelOperationRequest::setProjectId() — Method in class CancelOperationRequest
- The Google Developers Console project ID or project number.
- CancelOperationRequest::setZone() — Method in class CancelOperationRequest
- The name of the Google Compute Engine zone in which the operation resides.
- CancelOperationRequest::setOperationId() — Method in class CancelOperationRequest
- The server-assigned
nameof the operation. - ClientCertificateConfig::setIssueClientCertificate() — Method in class ClientCertificateConfig
- Issue a client certificate.
- Cluster::setName() — Method in class Cluster
- The name of this cluster. The name must be unique within this project and zone, and can be up to 40 characters with the following restrictions: * Lowercase letters, numbers, and hyphens only.
- Cluster::setDescription() — Method in class Cluster
- An optional description of this cluster.
- Cluster::setInitialNodeCount() — Method in class Cluster
- The number of nodes to create in this cluster. You must ensure that your Compute Engine resource quota is sufficient for this number of instances. You must also have available firewall and routes quota.
- Cluster::setNodeConfig() — Method in class Cluster
- Parameters used in creating the cluster's nodes.
- Cluster::setMasterAuth() — Method in class Cluster
- The authentication information for accessing the master endpoint.
- Cluster::setLoggingService() — Method in class Cluster
- The logging service the cluster should use to write logs.
- Cluster::setMonitoringService() — Method in class Cluster
- The monitoring service the cluster should use to write metrics.
- Cluster::setNetwork() — Method in class Cluster
- The name of the Google Compute Engine
network to which the
cluster is connected. If left unspecified, the
defaultnetwork will be used. - Cluster::setClusterIpv4Cidr() — Method in class Cluster
- The IP address range of the container pods in this cluster, in
CIDR
notation (e.g.
10.96.0.0/14). Leave blank to have one automatically chosen or specify a/14block in10.0.0.0/8. - Cluster::setAddonsConfig() — Method in class Cluster
- Configurations for the various addons available to run in the cluster.
- Cluster::setSubnetwork() — Method in class Cluster
- The name of the Google Compute Engine subnetwork to which the cluster is connected.
- Cluster::setNodePools() — Method in class Cluster
- The node pools associated with this cluster.
- Cluster::setLocations() — Method in class Cluster
- The list of Google Compute Engine locations in which the cluster's nodes should be located.
- Cluster::setEnableKubernetesAlpha() — Method in class Cluster
- Kubernetes alpha features are enabled on this cluster. This includes alpha API groups (e.g. v1alpha1) and features that may not be production ready in the kubernetes version of the master and nodes.
- Cluster::setResourceLabels() — Method in class Cluster
- The resource labels for the cluster to use to annotate any related Google Compute Engine resources.
- Cluster::setLabelFingerprint() — Method in class Cluster
- The fingerprint of the set of labels for this cluster.
- Cluster::setLegacyAbac() — Method in class Cluster
- Configuration for the legacy ABAC authorization mode.
- Cluster::setNetworkPolicy() — Method in class Cluster
- Configuration options for the NetworkPolicy feature.
- Cluster::setIpAllocationPolicy() — Method in class Cluster
- Configuration for cluster IP allocation.
- Cluster::setMasterAuthorizedNetworksConfig() — Method in class Cluster
- Master authorized networks is a Beta feature.
- Cluster::setMaintenancePolicy() — Method in class Cluster
- Configure the maintenance policy for this cluster.
- Cluster::setSelfLink() — Method in class Cluster
- [Output only] Server-defined URL for the resource.
- Cluster::setZone() — Method in class Cluster
- [Output only] The name of the Google Compute Engine zone in which the cluster resides.
- Cluster::setEndpoint() — Method in class Cluster
- [Output only] The IP address of this cluster's master endpoint.
- Cluster::setInitialClusterVersion() — Method in class Cluster
- The initial Kubernetes version for this cluster. Valid versions are those found in validMasterVersions returned by getServerConfig. The version can be upgraded over time; such upgrades are reflected in currentMasterVersion and currentNodeVersion.
- Cluster::setCurrentMasterVersion() — Method in class Cluster
- [Output only] The current software version of the master endpoint.
- Cluster::setCurrentNodeVersion() — Method in class Cluster
- [Output only] The current version of the node software components.
- Cluster::setCreateTime() — Method in class Cluster
- [Output only] The time the cluster was created, in RFC3339 text format.
- Cluster::setStatus() — Method in class Cluster
- [Output only] The current status of this cluster.
- Cluster::setStatusMessage() — Method in class Cluster
- [Output only] Additional information about the current status of this cluster, if available.
- Cluster::setNodeIpv4CidrSize() — Method in class Cluster
- [Output only] The size of the address space on each node for hosting
containers. This is provisioned from within the
container_ipv4_cidrrange. - Cluster::setServicesIpv4Cidr() — Method in class Cluster
- [Output only] The IP address range of the Kubernetes services in
this cluster, in
CIDR
notation (e.g.
1.2.3.4/29). Service addresses are typically put in the last/16from the container CIDR. - Cluster::setInstanceGroupUrls() — Method in class Cluster
- Deprecated. Use node_pools.instance_group_urls.
- Cluster::setCurrentNodeCount() — Method in class Cluster
- [Output only] The number of nodes currently in the cluster.
- Cluster::setExpireTime() — Method in class Cluster
- [Output only] The time the cluster will be automatically deleted in RFC3339 text format.
- ClusterManagerGrpcClient::SetNodePoolAutoscaling() — Method in class ClusterManagerGrpcClient
- Sets the autoscaling settings of a specific node pool.
- ClusterManagerGrpcClient::SetLoggingService() — Method in class ClusterManagerGrpcClient
- Sets the logging service of a specific cluster.
- ClusterManagerGrpcClient::SetMonitoringService() — Method in class ClusterManagerGrpcClient
- Sets the monitoring service of a specific cluster.
- ClusterManagerGrpcClient::SetAddonsConfig() — Method in class ClusterManagerGrpcClient
- Sets the addons of a specific cluster.
- ClusterManagerGrpcClient::SetLocations() — Method in class ClusterManagerGrpcClient
- Sets the locations of a specific cluster.
- ClusterManagerGrpcClient::SetMasterAuth() — Method in class ClusterManagerGrpcClient
- Used to set master auth materials. Currently supports :- Changing the admin password of a specific cluster.
- ClusterManagerGrpcClient::SetNodePoolManagement() — Method in class ClusterManagerGrpcClient
- Sets the NodeManagement options for a node pool.
- ClusterManagerGrpcClient::SetLabels() — Method in class ClusterManagerGrpcClient
- Sets labels on a cluster.
- ClusterManagerGrpcClient::SetLegacyAbac() — Method in class ClusterManagerGrpcClient
- Enables or disables the ABAC authorization mechanism on a cluster.
- ClusterManagerGrpcClient::StartIPRotation() — Method in class ClusterManagerGrpcClient
- Start master IP rotation.
- ClusterManagerGrpcClient::SetNodePoolSize() — Method in class ClusterManagerGrpcClient
- Sets the size of a specific node pool.
- ClusterManagerGrpcClient::SetNetworkPolicy() — Method in class ClusterManagerGrpcClient
- Enables/Disables Network Policy for a cluster.
- ClusterManagerGrpcClient::SetMaintenancePolicy() — Method in class ClusterManagerGrpcClient
- Sets the maintenance policy for a cluster.
- ClusterUpdate::setDesiredNodeVersion() — Method in class ClusterUpdate
- The Kubernetes version to change the nodes to (typically an
upgrade). Use
-to upgrade to the latest version supported by the server. - ClusterUpdate::setDesiredMonitoringService() — Method in class ClusterUpdate
- The monitoring service the cluster should use to write metrics.
- ClusterUpdate::setDesiredAddonsConfig() — Method in class ClusterUpdate
- Configurations for the various addons available to run in the cluster.
- ClusterUpdate::setDesiredNodePoolId() — Method in class ClusterUpdate
- The node pool to be upgraded. This field is mandatory if "desired_node_version", "desired_image_family" or "desired_node_pool_autoscaling" is specified and there is more than one node pool on the cluster.
- ClusterUpdate::setDesiredImageType() — Method in class ClusterUpdate
- The desired image type for the node pool.
- ClusterUpdate::setDesiredNodePoolAutoscaling() — Method in class ClusterUpdate
- Autoscaler configuration for the node pool specified in desired_node_pool_id. If there is only one pool in the cluster and desired_node_pool_id is not provided then the change applies to that single node pool.
- ClusterUpdate::setDesiredLocations() — Method in class ClusterUpdate
- The desired list of Google Compute Engine locations in which the cluster's nodes should be located. Changing the locations a cluster is in will result in nodes being either created or removed from the cluster, depending on whether locations are being added or removed.
- ClusterUpdate::setDesiredMasterAuthorizedNetworksConfig() — Method in class ClusterUpdate
- Master authorized networks is a Beta feature.
- ClusterUpdate::setDesiredMasterVersion() — Method in class ClusterUpdate
- The Kubernetes version to change the master to. The only valid value is the latest supported version. Use "-" to have the server automatically select the latest version.
- CompleteIPRotationRequest::setProjectId() — Method in class CompleteIPRotationRequest
- The Google Developers Console project ID or project number.
- CompleteIPRotationRequest::setZone() — Method in class CompleteIPRotationRequest
- The name of the Google Compute Engine zone in which the cluster resides.
- CompleteIPRotationRequest::setClusterId() — Method in class CompleteIPRotationRequest
- The name of the cluster.
- CreateClusterRequest::setProjectId() — Method in class CreateClusterRequest
- The Google Developers Console project ID or project number.
- CreateClusterRequest::setZone() — Method in class CreateClusterRequest
- The name of the Google Compute Engine zone in which the cluster resides.
- CreateClusterRequest::setCluster() — Method in class CreateClusterRequest
- A cluster resource
- CreateNodePoolRequest::setProjectId() — Method in class CreateNodePoolRequest
- The Google Developers Console project ID or project number.
- CreateNodePoolRequest::setZone() — Method in class CreateNodePoolRequest
- The name of the Google Compute Engine zone in which the cluster resides.
- CreateNodePoolRequest::setClusterId() — Method in class CreateNodePoolRequest
- The name of the cluster.
- CreateNodePoolRequest::setNodePool() — Method in class CreateNodePoolRequest
- The node pool to create.
- DailyMaintenanceWindow::setStartTime() — Method in class DailyMaintenanceWindow
- Time within the maintenance window to start the maintenance operations.
- DailyMaintenanceWindow::setDuration() — Method in class DailyMaintenanceWindow
- [Output only] Duration of the time window, automatically chosen to be smallest possible in the given scenario.
- DeleteClusterRequest::setProjectId() — Method in class DeleteClusterRequest
- The Google Developers Console project ID or project number.
- DeleteClusterRequest::setZone() — Method in class DeleteClusterRequest
- The name of the Google Compute Engine zone in which the cluster resides.
- DeleteClusterRequest::setClusterId() — Method in class DeleteClusterRequest
- The name of the cluster to delete.
- DeleteNodePoolRequest::setProjectId() — Method in class DeleteNodePoolRequest
- The Google Developers Console project ID or project number.
- DeleteNodePoolRequest::setZone() — Method in class DeleteNodePoolRequest
- The name of the Google Compute Engine zone in which the cluster resides.
- DeleteNodePoolRequest::setClusterId() — Method in class DeleteNodePoolRequest
- The name of the cluster.
- DeleteNodePoolRequest::setNodePoolId() — Method in class DeleteNodePoolRequest
- The name of the node pool to delete.
- GetClusterRequest::setProjectId() — Method in class GetClusterRequest
- The Google Developers Console project ID or project number.
- GetClusterRequest::setZone() — Method in class GetClusterRequest
- The name of the Google Compute Engine zone in which the cluster resides.
- GetClusterRequest::setClusterId() — Method in class GetClusterRequest
- The name of the cluster to retrieve.
- GetNodePoolRequest::setProjectId() — Method in class GetNodePoolRequest
- The Google Developers Console project ID or project number.
- GetNodePoolRequest::setZone() — Method in class GetNodePoolRequest
- The name of the Google Compute Engine zone in which the cluster resides.
- GetNodePoolRequest::setClusterId() — Method in class GetNodePoolRequest
- The name of the cluster.
- GetNodePoolRequest::setNodePoolId() — Method in class GetNodePoolRequest
- The name of the node pool.
- GetOperationRequest::setProjectId() — Method in class GetOperationRequest
- The Google Developers Console project ID or project number.
- GetOperationRequest::setZone() — Method in class GetOperationRequest
- The name of the Google Compute Engine zone in which the cluster resides.
- GetOperationRequest::setOperationId() — Method in class GetOperationRequest
- The server-assigned
nameof the operation. - GetServerConfigRequest::setProjectId() — Method in class GetServerConfigRequest
- The Google Developers Console project ID or project number.
- GetServerConfigRequest::setZone() — Method in class GetServerConfigRequest
- The name of the Google Compute Engine zone to return operations for.
- HorizontalPodAutoscaling::setDisabled() — Method in class HorizontalPodAutoscaling
- Whether the Horizontal Pod Autoscaling feature is enabled in the cluster.
- HttpLoadBalancing::setDisabled() — Method in class HttpLoadBalancing
- Whether the HTTP Load Balancing controller is enabled in the cluster.
- IPAllocationPolicy::setUseIpAliases() — Method in class IPAllocationPolicy
- Whether alias IPs will be used for pod IPs in the cluster.
- IPAllocationPolicy::setCreateSubnetwork() — Method in class IPAllocationPolicy
- Whether a new subnetwork will be created automatically for the cluster.
- IPAllocationPolicy::setSubnetworkName() — Method in class IPAllocationPolicy
- A custom subnetwork name to be used if
create_subnetworkis true. If this field is empty, then an automatic name will be chosen for the new subnetwork. - IPAllocationPolicy::setClusterIpv4Cidr() — Method in class IPAllocationPolicy
- This field is deprecated, use cluster_ipv4_cidr_block.
- IPAllocationPolicy::setNodeIpv4Cidr() — Method in class IPAllocationPolicy
- This field is deprecated, use node_ipv4_cidr_block.
- IPAllocationPolicy::setServicesIpv4Cidr() — Method in class IPAllocationPolicy
- This field is deprecated, use services_ipv4_cidr_block.
- IPAllocationPolicy::setClusterSecondaryRangeName() — Method in class IPAllocationPolicy
- The name of the secondary range to be used for the cluster CIDR block. The secondary range will be used for pod IP addresses. This must be an existing secondary range associated with the cluster subnetwork.
- IPAllocationPolicy::setServicesSecondaryRangeName() — Method in class IPAllocationPolicy
- The name of the secondary range to be used as for the services CIDR block. The secondary range will be used for service ClusterIPs. This must be an existing secondary range associated with the cluster subnetwork.
- IPAllocationPolicy::setClusterIpv4CidrBlock() — Method in class IPAllocationPolicy
- The IP address range for the cluster pod IPs. If this field is set, then
cluster.cluster_ipv4_cidrmust be left blank. - IPAllocationPolicy::setNodeIpv4CidrBlock() — Method in class IPAllocationPolicy
- The IP address range of the instance IPs in this cluster.
- IPAllocationPolicy::setServicesIpv4CidrBlock() — Method in class IPAllocationPolicy
- The IP address range of the services IPs in this cluster. If blank, a range will be automatically chosen with the default size.
- KubernetesDashboard::setDisabled() — Method in class KubernetesDashboard
- Whether the Kubernetes Dashboard is enabled for this cluster.
- LegacyAbac::setEnabled() — Method in class LegacyAbac
- Whether the ABAC authorizer is enabled for this cluster. When enabled, identities in the system, including service accounts, nodes, and controllers, will have statically granted permissions beyond those provided by the RBAC configuration or IAM.
- ListClustersRequest::setProjectId() — Method in class ListClustersRequest
- The Google Developers Console project ID or project number.
- ListClustersRequest::setZone() — Method in class ListClustersRequest
- The name of the Google Compute Engine zone in which the cluster resides, or "-" for all zones.
- ListClustersResponse::setClusters() — Method in class ListClustersResponse
- A list of clusters in the project in the specified zone, or across all ones.
- ListClustersResponse::setMissingZones() — Method in class ListClustersResponse
- If any zones are listed here, the list of clusters returned may be missing those zones.
- ListNodePoolsRequest::setProjectId() — Method in class ListNodePoolsRequest
- The Google Developers Console project ID or project number.
- ListNodePoolsRequest::setZone() — Method in class ListNodePoolsRequest
- The name of the Google Compute Engine zone in which the cluster resides.
- ListNodePoolsRequest::setClusterId() — Method in class ListNodePoolsRequest
- The name of the cluster.
- ListNodePoolsResponse::setNodePools() — Method in class ListNodePoolsResponse
- A list of node pools for a cluster.
- ListOperationsRequest::setProjectId() — Method in class ListOperationsRequest
- The Google Developers Console project ID or project number.
- ListOperationsRequest::setZone() — Method in class ListOperationsRequest
- The name of the Google Compute Engine zone
to return operations for, or
-for all zones. - ListOperationsResponse::setOperations() — Method in class ListOperationsResponse
- A list of operations in the project in the specified zone.
- ListOperationsResponse::setMissingZones() — Method in class ListOperationsResponse
- If any zones are listed here, the list of operations returned may be missing the operations from those zones.
- MaintenancePolicy::setWindow() — Method in class MaintenancePolicy
- Specifies the maintenance window in which maintenance may be performed.
- MaintenanceWindow::setDailyMaintenanceWindow() — Method in class MaintenanceWindow
- DailyMaintenanceWindow specifies a daily maintenance operation window.
- MasterAuth::setUsername() — Method in class MasterAuth
- The username to use for HTTP basic authentication to the master endpoint.
- MasterAuth::setPassword() — Method in class MasterAuth
- The password to use for HTTP basic authentication to the master endpoint.
- MasterAuth::setClientCertificateConfig() — Method in class MasterAuth
- Configuration for client certificate authentication on the cluster. If no configuration is specified, a client certificate is issued.
- MasterAuth::setClusterCaCertificate() — Method in class MasterAuth
- [Output only] Base64-encoded public certificate that is the root of trust for the cluster.
- MasterAuth::setClientCertificate() — Method in class MasterAuth
- [Output only] Base64-encoded public certificate used by clients to authenticate to the cluster endpoint.
- MasterAuth::setClientKey() — Method in class MasterAuth
- [Output only] Base64-encoded private key used by clients to authenticate to the cluster endpoint.
- MasterAuthorizedNetworksConfig::setEnabled() — Method in class MasterAuthorizedNetworksConfig
- Whether or not master authorized networks is enabled.
- MasterAuthorizedNetworksConfig::setCidrBlocks() — Method in class MasterAuthorizedNetworksConfig
- cidr_blocks define up to 10 external networks that could access Kubernetes master through HTTPS.
- MasterAuthorizedNetworksConfig_CidrBlock::setDisplayName() — Method in class MasterAuthorizedNetworksConfig_CidrBlock
- display_name is an optional field for users to identify CIDR blocks.
- MasterAuthorizedNetworksConfig_CidrBlock::setCidrBlock() — Method in class MasterAuthorizedNetworksConfig_CidrBlock
- cidr_block must be specified in CIDR notation.
- NetworkPolicy::setProvider() — Method in class NetworkPolicy
- The selected network policy provider.
- NetworkPolicy::setEnabled() — Method in class NetworkPolicy
- Whether network policy is enabled on the cluster.
- NetworkPolicyConfig::setDisabled() — Method in class NetworkPolicyConfig
- Whether NetworkPolicy is enabled for this cluster.
- NodeConfig::setMachineType() — Method in class NodeConfig
- The name of a Google Compute Engine machine type (e.g.
- NodeConfig::setDiskSizeGb() — Method in class NodeConfig
- Size of the disk attached to each node, specified in GB.
- NodeConfig::setOauthScopes() — Method in class NodeConfig
- The set of Google API scopes to be made available on all of the node VMs under the "default" service account.
- NodeConfig::setServiceAccount() — Method in class NodeConfig
- The Google Cloud Platform Service Account to be used by the node VMs. If no Service Account is specified, the "default" service account is used.
- NodeConfig::setMetadata() — Method in class NodeConfig
- The metadata key/value pairs assigned to instances in the cluster.
- NodeConfig::setImageType() — Method in class NodeConfig
- The image type to use for this node. Note that for a given image type, the latest version of it will be used.
- NodeConfig::setLabels() — Method in class NodeConfig
- The map of Kubernetes labels (key/value pairs) to be applied to each node.
- NodeConfig::setLocalSsdCount() — Method in class NodeConfig
- The number of local SSD disks to be attached to the node.
- NodeConfig::setTags() — Method in class NodeConfig
- The list of instance tags applied to all nodes. Tags are used to identify valid sources or targets for network firewalls and are specified by the client during cluster or node pool creation. Each tag within the list must comply with RFC1035.
- NodeConfig::setPreemptible() — Method in class NodeConfig
- Whether the nodes are created as preemptible VM instances. See: https://cloud.google.com/compute/docs/instances/preemptible for more information about preemptible VM instances.
- NodeConfig::setAccelerators() — Method in class NodeConfig
- A list of hardware accelerators to be attached to each node.
- NodeConfig::setMinCpuPlatform() — Method in class NodeConfig
- Minimum CPU platform to be used by this instance. The instance may be
scheduled on the specified or newer CPU platform. Applicable values are the
friendly names of CPU platforms, such as
minCpuPlatform: "Intel Haswell"orminCpuPlatform: "Intel Sandy Bridge". For more information, read how to specify min CPU platform - NodeManagement::setAutoUpgrade() — Method in class NodeManagement
- A flag that specifies whether node auto-upgrade is enabled for the node pool. If enabled, node auto-upgrade helps keep the nodes in your node pool up to date with the latest release version of Kubernetes.
- NodeManagement::setAutoRepair() — Method in class NodeManagement
- A flag that specifies whether the node auto-repair is enabled for the node pool. If enabled, the nodes in this node pool will be monitored and, if they fail health checks too many times, an automatic repair action will be triggered.
- NodeManagement::setUpgradeOptions() — Method in class NodeManagement
- Specifies the Auto Upgrade knobs for the node pool.
- NodePool::setName() — Method in class NodePool
- The name of the node pool.
- NodePool::setConfig() — Method in class NodePool
- The node configuration of the pool.
- NodePool::setInitialNodeCount() — Method in class NodePool
- The initial node count for the pool. You must ensure that your Compute Engine resource quota is sufficient for this number of instances. You must also have available firewall and routes quota.
- NodePool::setSelfLink() — Method in class NodePool
- [Output only] Server-defined URL for the resource.
- NodePool::setVersion() — Method in class NodePool
- The version of the Kubernetes of this node.
- NodePool::setInstanceGroupUrls() — Method in class NodePool
- [Output only] The resource URLs of the managed instance groups associated with this node pool.
- NodePool::setStatus() — Method in class NodePool
- [Output only] The status of the nodes in this pool instance.
- NodePool::setStatusMessage() — Method in class NodePool
- [Output only] Additional information about the current status of this node pool instance, if available.
- NodePool::setAutoscaling() — Method in class NodePool
- Autoscaler configuration for this NodePool. Autoscaler is enabled only if a valid configuration is present.
- NodePool::setManagement() — Method in class NodePool
- NodeManagement configuration for this NodePool.
- NodePoolAutoscaling::setEnabled() — Method in class NodePoolAutoscaling
- Is autoscaling enabled for this node pool.
- NodePoolAutoscaling::setMinNodeCount() — Method in class NodePoolAutoscaling
- Minimum number of nodes in the NodePool. Must be >= 1 and <= max_node_count.
- NodePoolAutoscaling::setMaxNodeCount() — Method in class NodePoolAutoscaling
- Maximum number of nodes in the NodePool. Must be >= min_node_count. There has to enough quota to scale up the cluster.
- Operation::setName() — Method in class Operation
- The server-assigned ID for the operation.
- Operation::setZone() — Method in class Operation
- The name of the Google Compute Engine zone in which the operation is taking place.
- Operation::setOperationType() — Method in class Operation
- The operation type.
- Operation::setStatus() — Method in class Operation
- The current status of the operation.
- Operation::setDetail() — Method in class Operation
- Detailed operation progress, if available.
- Operation::setStatusMessage() — Method in class Operation
- If an error has occurred, a textual description of the error.
- Operation::setSelfLink() — Method in class Operation
- Server-defined URL for the resource.
- Operation::setTargetLink() — Method in class Operation
- Server-defined URL for the target of the operation.
- Operation::setStartTime() — Method in class Operation
- [Output only] The time the operation started, in RFC3339 text format.
- Operation::setEndTime() — Method in class Operation
- [Output only] The time the operation completed, in RFC3339 text format.
- RollbackNodePoolUpgradeRequest::setProjectId() — Method in class RollbackNodePoolUpgradeRequest
- The Google Developers Console project ID or project number.
- RollbackNodePoolUpgradeRequest::setZone() — Method in class RollbackNodePoolUpgradeRequest
- The name of the Google Compute Engine zone in which the cluster resides.
- RollbackNodePoolUpgradeRequest::setClusterId() — Method in class RollbackNodePoolUpgradeRequest
- The name of the cluster to rollback.
- RollbackNodePoolUpgradeRequest::setNodePoolId() — Method in class RollbackNodePoolUpgradeRequest
- The name of the node pool to rollback.
- ServerConfig — Class in namespace Google\Cloud\Container\V1
- Container Engine service configuration.
- ServerConfig::setDefaultClusterVersion() — Method in class ServerConfig
- Version of Kubernetes the service deploys by default.
- ServerConfig::setValidNodeVersions() — Method in class ServerConfig
- List of valid node upgrade target versions.
- ServerConfig::setDefaultImageType() — Method in class ServerConfig
- Default image type.
- ServerConfig::setValidImageTypes() — Method in class ServerConfig
- List of valid image types.
- ServerConfig::setValidMasterVersions() — Method in class ServerConfig
- List of valid master versions.
- SetAddonsConfigRequest — Class in namespace Google\Cloud\Container\V1
- SetAddonsConfigRequest sets the addons associated with the cluster.
- SetAddonsConfigRequest::setProjectId() — Method in class SetAddonsConfigRequest
- The Google Developers Console project ID or project number.
- SetAddonsConfigRequest::setZone() — Method in class SetAddonsConfigRequest
- The name of the Google Compute Engine zone in which the cluster resides.
- SetAddonsConfigRequest::setClusterId() — Method in class SetAddonsConfigRequest
- The name of the cluster to upgrade.
- SetAddonsConfigRequest::setAddonsConfig() — Method in class SetAddonsConfigRequest
- The desired configurations for the various addons available to run in the cluster.
- SetLabelsRequest — Class in namespace Google\Cloud\Container\V1
- SetLabelsRequest sets the Google Cloud Platform labels on a Google Container Engine cluster, which will in turn set them for Google Compute Engine resources used by that cluster
- SetLabelsRequest::setProjectId() — Method in class SetLabelsRequest
- The Google Developers Console project ID or project number.
- SetLabelsRequest::setZone() — Method in class SetLabelsRequest
- The name of the Google Compute Engine zone in which the cluster resides.
- SetLabelsRequest::setClusterId() — Method in class SetLabelsRequest
- The name of the cluster.
- SetLabelsRequest::setResourceLabels() — Method in class SetLabelsRequest
- The labels to set for that cluster.
- SetLabelsRequest::setLabelFingerprint() — Method in class SetLabelsRequest
- The fingerprint of the previous set of labels for this resource,
used to detect conflicts. The fingerprint is initially generated by
Container Engine and changes after every request to modify or update
labels. You must always provide an up-to-date fingerprint hash when
updating or changing labels. Make a
get()request to the resource to get the latest fingerprint. - SetLegacyAbacRequest — Class in namespace Google\Cloud\Container\V1
- SetLegacyAbacRequest enables or disables the ABAC authorization mechanism for a cluster.
- SetLegacyAbacRequest::setProjectId() — Method in class SetLegacyAbacRequest
- The Google Developers Console project ID or project number.
- SetLegacyAbacRequest::setZone() — Method in class SetLegacyAbacRequest
- The name of the Google Compute Engine zone in which the cluster resides.
- SetLegacyAbacRequest::setClusterId() — Method in class SetLegacyAbacRequest
- The name of the cluster to update.
- SetLegacyAbacRequest::setEnabled() — Method in class SetLegacyAbacRequest
- Whether ABAC authorization will be enabled in the cluster.
- SetLocationsRequest — Class in namespace Google\Cloud\Container\V1
- SetLocationsRequest sets the locations of the cluster.
- SetLocationsRequest::setProjectId() — Method in class SetLocationsRequest
- The Google Developers Console project ID or project number.
- SetLocationsRequest::setZone() — Method in class SetLocationsRequest
- The name of the Google Compute Engine zone in which the cluster resides.
- SetLocationsRequest::setClusterId() — Method in class SetLocationsRequest
- The name of the cluster to upgrade.
- SetLocationsRequest::setLocations() — Method in class SetLocationsRequest
- The desired list of Google Compute Engine locations in which the cluster's nodes should be located. Changing the locations a cluster is in will result in nodes being either created or removed from the cluster, depending on whether locations are being added or removed.
- SetLoggingServiceRequest — Class in namespace Google\Cloud\Container\V1
- SetLoggingServiceRequest sets the logging service of a cluster.
- SetLoggingServiceRequest::setProjectId() — Method in class SetLoggingServiceRequest
- The Google Developers Console project ID or project number.
- SetLoggingServiceRequest::setZone() — Method in class SetLoggingServiceRequest
- The name of the Google Compute Engine zone in which the cluster resides.
- SetLoggingServiceRequest::setClusterId() — Method in class SetLoggingServiceRequest
- The name of the cluster to upgrade.
- SetLoggingServiceRequest::setLoggingService() — Method in class SetLoggingServiceRequest
- The logging service the cluster should use to write metrics.
- SetMaintenancePolicyRequest — Class in namespace Google\Cloud\Container\V1
- SetMaintenancePolicyRequest sets the maintenance policy for a cluster.
- SetMaintenancePolicyRequest::setProjectId() — Method in class SetMaintenancePolicyRequest
- The Google Developers Console project ID or project number.
- SetMaintenancePolicyRequest::setZone() — Method in class SetMaintenancePolicyRequest
- The name of the Google Compute Engine zone in which the cluster resides.
- SetMaintenancePolicyRequest::setClusterId() — Method in class SetMaintenancePolicyRequest
- The name of the cluster to update.
- SetMaintenancePolicyRequest::setMaintenancePolicy() — Method in class SetMaintenancePolicyRequest
- The maintenance policy to be set for the cluster. An empty field clears the existing maintenance policy.
- SetMasterAuthRequest — Class in namespace Google\Cloud\Container\V1
- SetMasterAuthRequest updates the admin password of a cluster.
- SetMasterAuthRequest::setProjectId() — Method in class SetMasterAuthRequest
- The Google Developers Console project ID or project number.
- SetMasterAuthRequest::setZone() — Method in class SetMasterAuthRequest
- The name of the Google Compute Engine zone in which the cluster resides.
- SetMasterAuthRequest::setClusterId() — Method in class SetMasterAuthRequest
- The name of the cluster to upgrade.
- SetMasterAuthRequest::setAction() — Method in class SetMasterAuthRequest
- The exact form of action to be taken on the master auth.
- SetMasterAuthRequest::setUpdate() — Method in class SetMasterAuthRequest
- A description of the update.
- SetMasterAuthRequest_Action — Class in namespace Google\Cloud\Container\V1
- Operation type: what type update to perform.
- SetMonitoringServiceRequest — Class in namespace Google\Cloud\Container\V1
- SetMonitoringServiceRequest sets the monitoring service of a cluster.
- SetMonitoringServiceRequest::setProjectId() — Method in class SetMonitoringServiceRequest
- The Google Developers Console project ID or project number.
- SetMonitoringServiceRequest::setZone() — Method in class SetMonitoringServiceRequest
- The name of the Google Compute Engine zone in which the cluster resides.
- SetMonitoringServiceRequest::setClusterId() — Method in class SetMonitoringServiceRequest
- The name of the cluster to upgrade.
- SetMonitoringServiceRequest::setMonitoringService() — Method in class SetMonitoringServiceRequest
- The monitoring service the cluster should use to write metrics.
- SetNetworkPolicyRequest — Class in namespace Google\Cloud\Container\V1
- SetNetworkPolicyRequest enables/disables network policy for a cluster.
- SetNetworkPolicyRequest::setProjectId() — Method in class SetNetworkPolicyRequest
- The Google Developers Console project ID or project number.
- SetNetworkPolicyRequest::setZone() — Method in class SetNetworkPolicyRequest
- The name of the Google Compute Engine zone in which the cluster resides.
- SetNetworkPolicyRequest::setClusterId() — Method in class SetNetworkPolicyRequest
- The name of the cluster.
- SetNetworkPolicyRequest::setNetworkPolicy() — Method in class SetNetworkPolicyRequest
- Configuration options for the NetworkPolicy feature.
- SetNodePoolAutoscalingRequest — Class in namespace Google\Cloud\Container\V1
- SetNodePoolAutoscalingRequest sets the autoscaler settings of a node pool.
- SetNodePoolAutoscalingRequest::setProjectId() — Method in class SetNodePoolAutoscalingRequest
- The Google Developers Console project ID or project number.
- SetNodePoolAutoscalingRequest::setZone() — Method in class SetNodePoolAutoscalingRequest
- The name of the Google Compute Engine zone in which the cluster resides.
- SetNodePoolAutoscalingRequest::setClusterId() — Method in class SetNodePoolAutoscalingRequest
- The name of the cluster to upgrade.
- SetNodePoolAutoscalingRequest::setNodePoolId() — Method in class SetNodePoolAutoscalingRequest
- The name of the node pool to upgrade.
- SetNodePoolAutoscalingRequest::setAutoscaling() — Method in class SetNodePoolAutoscalingRequest
- Autoscaling configuration for the node pool.
- SetNodePoolManagementRequest — Class in namespace Google\Cloud\Container\V1
- SetNodePoolManagementRequest sets the node management properties of a node pool.
- SetNodePoolManagementRequest::setProjectId() — Method in class SetNodePoolManagementRequest
- The Google Developers Console project ID or project number.
- SetNodePoolManagementRequest::setZone() — Method in class SetNodePoolManagementRequest
- The name of the Google Compute Engine zone in which the cluster resides.
- SetNodePoolManagementRequest::setClusterId() — Method in class SetNodePoolManagementRequest
- The name of the cluster to update.
- SetNodePoolManagementRequest::setNodePoolId() — Method in class SetNodePoolManagementRequest
- The name of the node pool to update.
- SetNodePoolManagementRequest::setManagement() — Method in class SetNodePoolManagementRequest
- NodeManagement configuration for the node pool.
- SetNodePoolSizeRequest — Class in namespace Google\Cloud\Container\V1
- SetNodePoolSizeRequest sets the size a node pool.
- SetNodePoolSizeRequest::setProjectId() — Method in class SetNodePoolSizeRequest
- The Google Developers Console project ID or project number.
- SetNodePoolSizeRequest::setZone() — Method in class SetNodePoolSizeRequest
- The name of the Google Compute Engine zone in which the cluster resides.
- SetNodePoolSizeRequest::setClusterId() — Method in class SetNodePoolSizeRequest
- The name of the cluster to update.
- SetNodePoolSizeRequest::setNodePoolId() — Method in class SetNodePoolSizeRequest
- The name of the node pool to update.
- SetNodePoolSizeRequest::setNodeCount() — Method in class SetNodePoolSizeRequest
- The desired node count for the pool.
- StartIPRotationRequest — Class in namespace Google\Cloud\Container\V1
- StartIPRotationRequest creates a new IP for the cluster and then performs a node upgrade on each node pool to point to the new IP.
- StartIPRotationRequest::setProjectId() — Method in class StartIPRotationRequest
- The Google Developers Console project ID or project number.
- StartIPRotationRequest::setZone() — Method in class StartIPRotationRequest
- The name of the Google Compute Engine zone in which the cluster resides.
- StartIPRotationRequest::setClusterId() — Method in class StartIPRotationRequest
- The name of the cluster.
- UpdateClusterRequest::setProjectId() — Method in class UpdateClusterRequest
- The Google Developers Console project ID or project number.
- UpdateClusterRequest::setZone() — Method in class UpdateClusterRequest
- The name of the Google Compute Engine zone in which the cluster resides.
- UpdateClusterRequest::setClusterId() — Method in class UpdateClusterRequest
- The name of the cluster to upgrade.
- UpdateClusterRequest::setUpdate() — Method in class UpdateClusterRequest
- A description of the update.
- UpdateMasterRequest::setProjectId() — Method in class UpdateMasterRequest
- The Google Developers Console project ID or project number.
- UpdateMasterRequest::setZone() — Method in class UpdateMasterRequest
- The name of the Google Compute Engine zone in which the cluster resides.
- UpdateMasterRequest::setClusterId() — Method in class UpdateMasterRequest
- The name of the cluster to upgrade.
- UpdateMasterRequest::setMasterVersion() — Method in class UpdateMasterRequest
- The Kubernetes version to change the master to. The only valid value is the latest supported version. Use "-" to have the server automatically select the latest version.
- UpdateNodePoolRequest::setProjectId() — Method in class UpdateNodePoolRequest
- The Google Developers Console project ID or project number.
- UpdateNodePoolRequest::setZone() — Method in class UpdateNodePoolRequest
- The name of the Google Compute Engine zone in which the cluster resides.
- UpdateNodePoolRequest::setClusterId() — Method in class UpdateNodePoolRequest
- The name of the cluster to upgrade.
- UpdateNodePoolRequest::setNodePoolId() — Method in class UpdateNodePoolRequest
- The name of the node pool to upgrade.
- UpdateNodePoolRequest::setNodeVersion() — Method in class UpdateNodePoolRequest
- The Kubernetes version to change the nodes to (typically an
upgrade). Use
-to upgrade to the latest version supported by the server. - UpdateNodePoolRequest::setImageType() — Method in class UpdateNodePoolRequest
- The desired image type for the node pool.
- AcceleratorConfig::setAcceleratorTypeUri() — Method in class AcceleratorConfig
- Full URL, partial URI, or short name of the accelerator type resource to
expose to this instance. See Google Compute Engine AcceleratorTypes
Examples
*
https://www.googleapis.com/compute/beta/projects/[project_id]/zones/us-east1-a/acceleratorTypes/nvidia-tesla-k80*projects/[project_id]/zones/us-east1-a/acceleratorTypes/nvidia-tesla-k80*nvidia-tesla-k80 - AcceleratorConfig::setAcceleratorCount() — Method in class AcceleratorConfig
- The number of the accelerator cards of this type exposed to this instance.
- CancelJobRequest::setProjectId() — Method in class CancelJobRequest
- Required. The ID of the Google Cloud Platform project that the job belongs to.
- CancelJobRequest::setRegion() — Method in class CancelJobRequest
- Required. The Cloud Dataproc region in which to handle the request.
- CancelJobRequest::setJobId() — Method in class CancelJobRequest
- Required. The job ID.
- Cluster::setProjectId() — Method in class Cluster
- Required. The Google Cloud Platform project ID that the cluster belongs to.
- Cluster::setClusterName() — Method in class Cluster
- Required. The cluster name. Cluster names within a project must be unique. Names of deleted clusters can be reused.
- Cluster::setConfig() — Method in class Cluster
- Required. The cluster config. Note that Cloud Dataproc may set default values, and values may change when clusters are updated.
- Cluster::setLabels() — Method in class Cluster
- Optional. The labels to associate with this cluster.
- Cluster::setStatus() — Method in class Cluster
- Output-only. Cluster status.
- Cluster::setStatusHistory() — Method in class Cluster
- Output-only. The previous cluster status.
- Cluster::setClusterUuid() — Method in class Cluster
- Output-only. A cluster UUID (Unique Universal Identifier). Cloud Dataproc generates this value when it creates the cluster.
- Cluster::setMetrics() — Method in class Cluster
- Contains cluster daemon metrics such as HDFS and YARN stats.
- ClusterConfig::setConfigBucket() — Method in class ClusterConfig
- Optional. A Google Cloud Storage staging bucket used for sharing generated SSH keys and config. If you do not specify a staging bucket, Cloud Dataproc will determine an appropriate Cloud Storage location (US, ASIA, or EU) for your cluster's staging bucket according to the Google Compute Engine zone where your cluster is deployed, and then it will create and manage this project-level, per-location bucket for you.
- ClusterConfig::setGceClusterConfig() — Method in class ClusterConfig
- Required. The shared Google Compute Engine config settings for all instances in a cluster.
- ClusterConfig::setMasterConfig() — Method in class ClusterConfig
- Optional. The Google Compute Engine config settings for the master instance in a cluster.
- ClusterConfig::setWorkerConfig() — Method in class ClusterConfig
- Optional. The Google Compute Engine config settings for worker instances in a cluster.
- ClusterConfig::setSecondaryWorkerConfig() — Method in class ClusterConfig
- Optional. The Google Compute Engine config settings for additional worker instances in a cluster.
- ClusterConfig::setSoftwareConfig() — Method in class ClusterConfig
- Optional. The config settings for software inside the cluster.
- ClusterConfig::setInitializationActions() — Method in class ClusterConfig
- Optional. Commands to execute on each node after config is completed. By default, executables are run on master and all worker nodes.
- ClusterMetrics::setHdfsMetrics() — Method in class ClusterMetrics
- The HDFS metrics.
- ClusterMetrics::setYarnMetrics() — Method in class ClusterMetrics
- The YARN metrics.
- ClusterOperationMetadata::setClusterName() — Method in class ClusterOperationMetadata
- Output-only. Name of the cluster for the operation.
- ClusterOperationMetadata::setClusterUuid() — Method in class ClusterOperationMetadata
- Output-only. Cluster UUID for the operation.
- ClusterOperationMetadata::setStatus() — Method in class ClusterOperationMetadata
- Output-only. Current operation status.
- ClusterOperationMetadata::setStatusHistory() — Method in class ClusterOperationMetadata
- Output-only. The previous operation status.
- ClusterOperationMetadata::setOperationType() — Method in class ClusterOperationMetadata
- Output-only. The operation type.
- ClusterOperationMetadata::setDescription() — Method in class ClusterOperationMetadata
- Output-only. Short description of operation.
- ClusterOperationMetadata::setLabels() — Method in class ClusterOperationMetadata
- Output-only. Labels associated with the operation
- ClusterOperationMetadata::setWarnings() — Method in class ClusterOperationMetadata
- Output-only. Errors encountered during operation execution.
- ClusterOperationStatus::setState() — Method in class ClusterOperationStatus
- Output-only. A message containing the operation state.
- ClusterOperationStatus::setInnerState() — Method in class ClusterOperationStatus
- Output-only. A message containing the detailed operation state.
- ClusterOperationStatus::setDetails() — Method in class ClusterOperationStatus
- Output-only.A message containing any operation metadata details.
- ClusterOperationStatus::setStateStartTime() — Method in class ClusterOperationStatus
- Output-only. The time this state was entered.
- ClusterStatus::setState() — Method in class ClusterStatus
- Output-only. The cluster's state.
- ClusterStatus::setDetail() — Method in class ClusterStatus
- Output-only. Optional details of cluster's state.
- ClusterStatus::setStateStartTime() — Method in class ClusterStatus
- Output-only. Time when this state was entered.
- ClusterStatus::setSubstate() — Method in class ClusterStatus
- Output-only. Additional state information that includes status reported by the agent.
- CreateClusterRequest::setProjectId() — Method in class CreateClusterRequest
- Required. The ID of the Google Cloud Platform project that the cluster belongs to.
- CreateClusterRequest::setRegion() — Method in class CreateClusterRequest
- Required. The Cloud Dataproc region in which to handle the request.
- CreateClusterRequest::setCluster() — Method in class CreateClusterRequest
- Required. The cluster to create.
- DeleteClusterRequest::setProjectId() — Method in class DeleteClusterRequest
- Required. The ID of the Google Cloud Platform project that the cluster belongs to.
- DeleteClusterRequest::setRegion() — Method in class DeleteClusterRequest
- Required. The Cloud Dataproc region in which to handle the request.
- DeleteClusterRequest::setClusterName() — Method in class DeleteClusterRequest
- Required. The cluster name.
- DeleteJobRequest::setProjectId() — Method in class DeleteJobRequest
- Required. The ID of the Google Cloud Platform project that the job belongs to.
- DeleteJobRequest::setRegion() — Method in class DeleteJobRequest
- Required. The Cloud Dataproc region in which to handle the request.
- DeleteJobRequest::setJobId() — Method in class DeleteJobRequest
- Required. The job ID.
- DiagnoseClusterRequest::setProjectId() — Method in class DiagnoseClusterRequest
- Required. The ID of the Google Cloud Platform project that the cluster belongs to.
- DiagnoseClusterRequest::setRegion() — Method in class DiagnoseClusterRequest
- Required. The Cloud Dataproc region in which to handle the request.
- DiagnoseClusterRequest::setClusterName() — Method in class DiagnoseClusterRequest
- Required. The cluster name.
- DiagnoseClusterResults::setOutputUri() — Method in class DiagnoseClusterResults
- Output-only. The Google Cloud Storage URI of the diagnostic output.
- DiskConfig::setBootDiskSizeGb() — Method in class DiskConfig
- Optional. Size in GB of the boot disk (default is 500GB).
- DiskConfig::setNumLocalSsds() — Method in class DiskConfig
- Optional. Number of attached SSDs, from 0 to 4 (default is 0).
- GceClusterConfig::setZoneUri() — Method in class GceClusterConfig
- Optional. The zone where the Google Compute Engine cluster will be located.
- GceClusterConfig::setNetworkUri() — Method in class GceClusterConfig
- Optional. The Google Compute Engine network to be used for machine
communications. Cannot be specified with subnetwork_uri. If neither
network_urinorsubnetwork_uriis specified, the "default" network of the project is used, if it exists. Cannot be a "Custom Subnet Network" (see Using Subnetworks for more information). - GceClusterConfig::setSubnetworkUri() — Method in class GceClusterConfig
- Optional. The Google Compute Engine subnetwork to be used for machine communications. Cannot be specified with network_uri.
- GceClusterConfig::setInternalIpOnly() — Method in class GceClusterConfig
- Optional. If true, all instances in the cluster will only have internal IP addresses. By default, clusters are not restricted to internal IP addresses, and will have ephemeral external IP addresses assigned to each instance.
- GceClusterConfig::setServiceAccount() — Method in class GceClusterConfig
- Optional. The service account of the instances. Defaults to the default Google Compute Engine service account. Custom service accounts need permissions equivalent to the folloing IAM roles: * roles/logging.logWriter * roles/storage.objectAdmin (see https://cloud.google.com/compute/docs/access/service-accounts#custom_service_accounts for more information).
- GceClusterConfig::setServiceAccountScopes() — Method in class GceClusterConfig
- Optional. The URIs of service account scopes to be included in Google Compute Engine instances. The following base set of scopes is always included: * https://www.googleapis.com/auth/cloud.useraccounts.readonly * https://www.googleapis.com/auth/devstorage.read_write * https://www.googleapis.com/auth/logging.write If no scopes are specified, the following defaults are also provided: * https://www.googleapis.com/auth/bigquery * https://www.googleapis.com/auth/bigtable.admin.table * https://www.googleapis.com/auth/bigtable.data * https://www.googleapis.com/auth/devstorage.full_control
- GceClusterConfig::setTags() — Method in class GceClusterConfig
- The Google Compute Engine tags to add to all instances (see Tagging instances).
- GceClusterConfig::setMetadata() — Method in class GceClusterConfig
- The Google Compute Engine metadata entries to add to all instances (see Project and instance metadata).
- GetClusterRequest::setProjectId() — Method in class GetClusterRequest
- Required. The ID of the Google Cloud Platform project that the cluster belongs to.
- GetClusterRequest::setRegion() — Method in class GetClusterRequest
- Required. The Cloud Dataproc region in which to handle the request.
- GetClusterRequest::setClusterName() — Method in class GetClusterRequest
- Required. The cluster name.
- GetJobRequest::setProjectId() — Method in class GetJobRequest
- Required. The ID of the Google Cloud Platform project that the job belongs to.
- GetJobRequest::setRegion() — Method in class GetJobRequest
- Required. The Cloud Dataproc region in which to handle the request.
- GetJobRequest::setJobId() — Method in class GetJobRequest
- Required. The job ID.
- HadoopJob::setMainJarFileUri() — Method in class HadoopJob
- The HCFS URI of the jar file containing the main class.
- HadoopJob::setMainClass() — Method in class HadoopJob
- The name of the driver's main class. The jar file containing the class
must be in the default CLASSPATH or specified in
jar_file_uris. - HadoopJob::setArgs() — Method in class HadoopJob
- Optional. The arguments to pass to the driver. Do not
include arguments, such as
-libjarsor-Dfoo=bar, that can be set as job properties, since a collision may occur that causes an incorrect job submission. - HadoopJob::setJarFileUris() — Method in class HadoopJob
- Optional. Jar file URIs to add to the CLASSPATHs of the Hadoop driver and tasks.
- HadoopJob::setFileUris() — Method in class HadoopJob
- Optional. HCFS (Hadoop Compatible Filesystem) URIs of files to be copied to the working directory of Hadoop drivers and distributed tasks. Useful for naively parallel tasks.
- HadoopJob::setArchiveUris() — Method in class HadoopJob
- Optional. HCFS URIs of archives to be extracted in the working directory of Hadoop drivers and tasks. Supported file types:
- HadoopJob::setProperties() — Method in class HadoopJob
- Optional. A mapping of property names to values, used to configure Hadoop.
- HadoopJob::setLoggingConfig() — Method in class HadoopJob
- Optional. The runtime log config for job execution.
- HiveJob::setQueryFileUri() — Method in class HiveJob
- The HCFS URI of the script that contains Hive queries.
- HiveJob::setQueryList() — Method in class HiveJob
- A list of queries.
- HiveJob::setContinueOnFailure() — Method in class HiveJob
- Optional. Whether to continue executing queries if a query fails.
- HiveJob::setScriptVariables() — Method in class HiveJob
- Optional. Mapping of query variable names to values (equivalent to the
Hive command:
SET name="value";). - HiveJob::setProperties() — Method in class HiveJob
- Optional. A mapping of property names and values, used to configure Hive.
- HiveJob::setJarFileUris() — Method in class HiveJob
- Optional. HCFS URIs of jar files to add to the CLASSPATH of the Hive server and Hadoop MapReduce (MR) tasks. Can contain Hive SerDes and UDFs.
- InstanceGroupConfig::setNumInstances() — Method in class InstanceGroupConfig
- Optional. The number of VM instances in the instance group.
- InstanceGroupConfig::setInstanceNames() — Method in class InstanceGroupConfig
- Optional. The list of instance names. Cloud Dataproc derives the names from
cluster_name,num_instances, and the instance group if not set by user (recommended practice is to let Cloud Dataproc derive the name). - InstanceGroupConfig::setImageUri() — Method in class InstanceGroupConfig
- Output-only. The Google Compute Engine image resource used for cluster
instances. Inferred from
SoftwareConfig.image_version. - InstanceGroupConfig::setMachineTypeUri() — Method in class InstanceGroupConfig
- Optional. The Google Compute Engine machine type used for cluster instances.
- InstanceGroupConfig::setDiskConfig() — Method in class InstanceGroupConfig
- Optional. Disk option config settings.
- InstanceGroupConfig::setIsPreemptible() — Method in class InstanceGroupConfig
- Optional. Specifies that this instance group contains preemptible instances.
- InstanceGroupConfig::setManagedGroupConfig() — Method in class InstanceGroupConfig
- Output-only. The config for Google Compute Engine Instance Group Manager that manages this group.
- InstanceGroupConfig::setAccelerators() — Method in class InstanceGroupConfig
- Optional. The Google Compute Engine accelerator configuration for these instances.
- Job::setReference() — Method in class Job
- Optional. The fully qualified reference to the job, which can be used to
obtain the equivalent REST path of the job resource. If this property
is not specified when a job is created, the server generates a
job_id. - Job::setPlacement() — Method in class Job
- Required. Job information, including how, when, and where to run the job.
- Job::setHadoopJob() — Method in class Job
- Job is a Hadoop job.
- Job::setSparkJob() — Method in class Job
- Job is a Spark job.
- Job::setPysparkJob() — Method in class Job
- Job is a Pyspark job.
- Job::setHiveJob() — Method in class Job
- Job is a Hive job.
- Job::setPigJob() — Method in class Job
- Job is a Pig job.
- Job::setSparkSqlJob() — Method in class Job
- Job is a SparkSql job.
- Job::setStatus() — Method in class Job
- Output-only. The job status. Additional application-specific
status information may be contained in the
type_jobandyarn_applicationsfields. - Job::setStatusHistory() — Method in class Job
- Output-only. The previous job status.
- Job::setYarnApplications() — Method in class Job
- Output-only. The collection of YARN applications spun up by this job.
- Job::setDriverOutputResourceUri() — Method in class Job
- Output-only. A URI pointing to the location of the stdout of the job's driver program.
- Job::setDriverControlFilesUri() — Method in class Job
- Output-only. If present, the location of miscellaneous control files
which may be used as part of job setup and handling. If not present,
control files may be placed in the same location as
driver_output_uri. - Job::setLabels() — Method in class Job
- Optional. The labels to associate with this job.
- Job::setScheduling() — Method in class Job
- Optional. Job scheduling configuration.
- JobControllerGrpcClient::SubmitJob() — Method in class JobControllerGrpcClient
- Submits a job to a cluster.
- JobPlacement::setClusterName() — Method in class JobPlacement
- Required. The name of the cluster where the job will be submitted.
- JobPlacement::setClusterUuid() — Method in class JobPlacement
- Output-only. A cluster UUID generated by the Cloud Dataproc service when the job is submitted.
- JobReference::setProjectId() — Method in class JobReference
- Required. The ID of the Google Cloud Platform project that the job belongs to.
- JobReference::setJobId() — Method in class JobReference
- Optional. The job ID, which must be unique within the project. The job ID is generated by the server upon job submission or provided by the user as a means to perform retries without creating duplicate jobs. The ID must contain only letters (a-z, A-Z), numbers (0-9), underscores (_), or hyphens (-). The maximum length is 100 characters.
- JobScheduling::setMaxFailuresPerHour() — Method in class JobScheduling
- Optional. Maximum number of times per hour a driver may be restarted as a result of driver terminating with non-zero code before job is reported failed.
- JobStatus::setState() — Method in class JobStatus
- Output-only. A state message specifying the overall job state.
- JobStatus::setDetails() — Method in class JobStatus
- Output-only. Optional job state details, such as an error
description if the state is
ERROR. - JobStatus::setStateStartTime() — Method in class JobStatus
- Output-only. The time when this state was entered.
- JobStatus::setSubstate() — Method in class JobStatus
- Output-only. Additional state information, which includes status reported by the agent.
- ListClustersRequest::setProjectId() — Method in class ListClustersRequest
- Required. The ID of the Google Cloud Platform project that the cluster belongs to.
- ListClustersRequest::setRegion() — Method in class ListClustersRequest
- Required. The Cloud Dataproc region in which to handle the request.
- ListClustersRequest::setFilter() — Method in class ListClustersRequest
- Optional. A filter constraining the clusters to list. Filters are case-sensitive and have the following syntax: field = value [AND [field = value]] .
- ListClustersRequest::setPageSize() — Method in class ListClustersRequest
- Optional. The standard List page size.
- ListClustersRequest::setPageToken() — Method in class ListClustersRequest
- Optional. The standard List page token.
- ListClustersResponse::setClusters() — Method in class ListClustersResponse
- Output-only. The clusters in the project.
- ListClustersResponse::setNextPageToken() — Method in class ListClustersResponse
- Output-only. This token is included in the response if there are more
results to fetch. To fetch additional results, provide this value as the
page_tokenin a subsequentListClustersRequest. - ListJobsRequest::setProjectId() — Method in class ListJobsRequest
- Required. The ID of the Google Cloud Platform project that the job belongs to.
- ListJobsRequest::setRegion() — Method in class ListJobsRequest
- Required. The Cloud Dataproc region in which to handle the request.
- ListJobsRequest::setPageSize() — Method in class ListJobsRequest
- Optional. The number of results to return in each response.
- ListJobsRequest::setPageToken() — Method in class ListJobsRequest
- Optional. The page token, returned by a previous call, to request the next page of results.
- ListJobsRequest::setClusterName() — Method in class ListJobsRequest
- Optional. If set, the returned jobs list includes only jobs that were submitted to the named cluster.
- ListJobsRequest::setJobStateMatcher() — Method in class ListJobsRequest
- Optional. Specifies enumerated categories of jobs to list.
- ListJobsRequest::setFilter() — Method in class ListJobsRequest
- Optional. A filter constraining the jobs to list. Filters are case-sensitive and have the following syntax: [field = value] AND [field [= value]] .
- ListJobsResponse::setJobs() — Method in class ListJobsResponse
- Output-only. Jobs list.
- ListJobsResponse::setNextPageToken() — Method in class ListJobsResponse
- Optional. This token is included in the response if there are more results
to fetch. To fetch additional results, provide this value as the
page_tokenin a subsequentListJobsRequest. - LoggingConfig::setDriverLogLevels() — Method in class LoggingConfig
- The per-package log levels for the driver. This may include "root" package name to configure rootLogger.
- ManagedGroupConfig::setInstanceTemplateName() — Method in class ManagedGroupConfig
- Output-only. The name of the Instance Template used for the Managed Instance Group.
- ManagedGroupConfig::setInstanceGroupManagerName() — Method in class ManagedGroupConfig
- Output-only. The name of the Instance Group Manager for this group.
- NodeInitializationAction::setExecutableFile() — Method in class NodeInitializationAction
- Required. Google Cloud Storage URI of executable file.
- NodeInitializationAction::setExecutionTimeout() — Method in class NodeInitializationAction
- Optional. Amount of time executable has to complete. Default is 10 minutes. Cluster creation fails with an explanatory error message (the name of the executable that caused the error and the exceeded timeout period) if the executable is not completed at end of the timeout period.
- PigJob::setQueryFileUri() — Method in class PigJob
- The HCFS URI of the script that contains the Pig queries.
- PigJob::setQueryList() — Method in class PigJob
- A list of queries.
- PigJob::setContinueOnFailure() — Method in class PigJob
- Optional. Whether to continue executing queries if a query fails.
- PigJob::setScriptVariables() — Method in class PigJob
- Optional. Mapping of query variable names to values (equivalent to the Pig
command:
name=[value]). - PigJob::setProperties() — Method in class PigJob
- Optional. A mapping of property names to values, used to configure Pig.
- PigJob::setJarFileUris() — Method in class PigJob
- Optional. HCFS URIs of jar files to add to the CLASSPATH of the Pig Client and Hadoop MapReduce (MR) tasks. Can contain Pig UDFs.
- PigJob::setLoggingConfig() — Method in class PigJob
- Optional. The runtime log config for job execution.
- PySparkJob::setMainPythonFileUri() — Method in class PySparkJob
- Required. The HCFS URI of the main Python file to use as the driver. Must be a .py file.
- PySparkJob::setArgs() — Method in class PySparkJob
- Optional. The arguments to pass to the driver. Do not include arguments,
such as
--conf, that can be set as job properties, since a collision may occur that causes an incorrect job submission. - PySparkJob::setPythonFileUris() — Method in class PySparkJob
- Optional. HCFS file URIs of Python files to pass to the PySpark framework. Supported file types: .py, .egg, and .zip.
- PySparkJob::setJarFileUris() — Method in class PySparkJob
- Optional. HCFS URIs of jar files to add to the CLASSPATHs of the Python driver and tasks.
- PySparkJob::setFileUris() — Method in class PySparkJob
- Optional. HCFS URIs of files to be copied to the working directory of Python drivers and distributed tasks. Useful for naively parallel tasks.
- PySparkJob::setArchiveUris() — Method in class PySparkJob
- Optional. HCFS URIs of archives to be extracted in the working directory of
- PySparkJob::setProperties() — Method in class PySparkJob
- Optional. A mapping of property names to values, used to configure PySpark.
- PySparkJob::setLoggingConfig() — Method in class PySparkJob
- Optional. The runtime log config for job execution.
- QueryList::setQueries() — Method in class QueryList
- Required. The queries to execute. You do not need to terminate a query with a semicolon. Multiple queries can be specified in one string by separating each with a semicolon. Here is an example of an Cloud Dataproc API snippet that uses a QueryList to specify a HiveJob: "hiveJob": { "queryList": { "queries": [ "query1", "query2", "query3;query4", ] } }
- SoftwareConfig — Class in namespace Google\Cloud\Dataproc\V1
- Specifies the selection and config of software inside the cluster.
- SoftwareConfig::setImageVersion() — Method in class SoftwareConfig
- Optional. The version of software inside the cluster. It must match the
regular expression
[0-9]+\.[0-9]+. If unspecified, it defaults to the latest version (see Cloud Dataproc Versioning). - SoftwareConfig::setProperties() — Method in class SoftwareConfig
- Optional. The properties to set on daemon config files.
- SparkJob — Class in namespace Google\Cloud\Dataproc\V1
- A Cloud Dataproc job for running Apache Spark applications on YARN.
- SparkJob::setMainJarFileUri() — Method in class SparkJob
- The HCFS URI of the jar file that contains the main class.
- SparkJob::setMainClass() — Method in class SparkJob
- The name of the driver's main class. The jar file that contains the class
must be in the default CLASSPATH or specified in
jar_file_uris. - SparkJob::setArgs() — Method in class SparkJob
- Optional. The arguments to pass to the driver. Do not include arguments,
such as
--conf, that can be set as job properties, since a collision may occur that causes an incorrect job submission. - SparkJob::setJarFileUris() — Method in class SparkJob
- Optional. HCFS URIs of jar files to add to the CLASSPATHs of the Spark driver and tasks.
- SparkJob::setFileUris() — Method in class SparkJob
- Optional. HCFS URIs of files to be copied to the working directory of Spark drivers and distributed tasks. Useful for naively parallel tasks.
- SparkJob::setArchiveUris() — Method in class SparkJob
- Optional. HCFS URIs of archives to be extracted in the working directory of Spark drivers and tasks. Supported file types:
- SparkJob::setProperties() — Method in class SparkJob
- Optional. A mapping of property names to values, used to configure Spark.
- SparkJob::setLoggingConfig() — Method in class SparkJob
- Optional. The runtime log config for job execution.
- SparkSqlJob — Class in namespace Google\Cloud\Dataproc\V1
- A Cloud Dataproc job for running Apache Spark SQL queries.
- SparkSqlJob::setQueryFileUri() — Method in class SparkSqlJob
- The HCFS URI of the script that contains SQL queries.
- SparkSqlJob::setQueryList() — Method in class SparkSqlJob
- A list of queries.
- SparkSqlJob::setScriptVariables() — Method in class SparkSqlJob
- Optional. Mapping of query variable names to values (equivalent to the
Spark SQL command: SET
name="value";). - SparkSqlJob::setProperties() — Method in class SparkSqlJob
- Optional. A mapping of property names to values, used to configure Spark SQL's SparkConf. Properties that conflict with values set by the Cloud Dataproc API may be overwritten.
- SparkSqlJob::setJarFileUris() — Method in class SparkSqlJob
- Optional. HCFS URIs of jar files to be added to the Spark CLASSPATH.
- SparkSqlJob::setLoggingConfig() — Method in class SparkSqlJob
- Optional. The runtime log config for job execution.
- SubmitJobRequest — Class in namespace Google\Cloud\Dataproc\V1
- A request to submit a job.
- SubmitJobRequest::setProjectId() — Method in class SubmitJobRequest
- Required. The ID of the Google Cloud Platform project that the job belongs to.
- SubmitJobRequest::setRegion() — Method in class SubmitJobRequest
- Required. The Cloud Dataproc region in which to handle the request.
- SubmitJobRequest::setJob() — Method in class SubmitJobRequest
- Required. The job resource.
- UpdateClusterRequest::setProjectId() — Method in class UpdateClusterRequest
- Required. The ID of the Google Cloud Platform project the cluster belongs to.
- UpdateClusterRequest::setRegion() — Method in class UpdateClusterRequest
- Required. The Cloud Dataproc region in which to handle the request.
- UpdateClusterRequest::setClusterName() — Method in class UpdateClusterRequest
- Required. The cluster name.
- UpdateClusterRequest::setCluster() — Method in class UpdateClusterRequest
- Required. The changes to the cluster.
- UpdateClusterRequest::setUpdateMask() — Method in class UpdateClusterRequest
- Required. Specifies the path, relative to
Cluster, of the field to update. For example, to change the number of workers in a cluster to 5, theupdate_maskparameter would be specified asconfig.worker_config.num_instances, and thePATCHrequest body would specify the new value, as follows: { "config":{ "workerConfig":{ "numInstances":"5" } } } Similarly, to change the number of preemptible workers in a cluster to 5, theupdate_maskparameter would beconfig.secondary_worker_config.num_instances, and thePATCHrequest body would be set as follows: { "config":{ "secondaryWorkerConfig":{ "numInstances":"5" } } } Note: Currently, only the following fields can be updated:Mask Purpose labels Update labels config.worker_config.num_instances Resize primary worker group config.secondary_worker_config.num_instances Resize secondary worker group - UpdateJobRequest::setProjectId() — Method in class UpdateJobRequest
- Required. The ID of the Google Cloud Platform project that the job belongs to.
- UpdateJobRequest::setRegion() — Method in class UpdateJobRequest
- Required. The Cloud Dataproc region in which to handle the request.
- UpdateJobRequest::setJobId() — Method in class UpdateJobRequest
- Required. The job ID.
- UpdateJobRequest::setJob() — Method in class UpdateJobRequest
- Required. The changes to the job.
- UpdateJobRequest::setUpdateMask() — Method in class UpdateJobRequest
- Required. Specifies the path, relative to
Job, of the field to update. For example, to update the labels of a Job theupdate_maskparameter would be specified aslabels, and thePATCHrequest body would specify the new value. Note: Currently,labelsis the only field that can be updated. - YarnApplication::setName() — Method in class YarnApplication
- Required. The application name.
- YarnApplication::setState() — Method in class YarnApplication
- Required. The application state.
- YarnApplication::setProgress() — Method in class YarnApplication
- Required. The numerical progress of the application, from 1 to 100.
- YarnApplication::setTrackingUrl() — Method in class YarnApplication
- Optional. The HTTP URL of the ApplicationMaster, HistoryServer, or TimelineServer that provides application-specific information. The URL uses the internal hostname, and requires a proxy server for resolution and, possibly, access.
- Breakpoint::setId() — Method in class Breakpoint
- Breakpoint identifier, unique in the scope of the debuggee.
- Breakpoint::setAction() — Method in class Breakpoint
- Action that the agent should perform when the code at the breakpoint location is hit.
- Breakpoint::setLocation() — Method in class Breakpoint
- Breakpoint source location.
- Breakpoint::setCondition() — Method in class Breakpoint
- Condition that triggers the breakpoint.
- Breakpoint::setExpressions() — Method in class Breakpoint
- List of read-only expressions to evaluate at the breakpoint location.
- Breakpoint::setLogMessageFormat() — Method in class Breakpoint
- Only relevant when action is
LOG. Defines the message to log when the breakpoint hits. The message may include parameter placeholders$0,$1, etc. These placeholders are replaced with the evaluated value of the appropriate expression. Expressions not referenced inlog_message_formatare not logged. - Breakpoint::setLogLevel() — Method in class Breakpoint
- Indicates the severity of the log. Only relevant when action is
LOG. - Breakpoint::setIsFinalState() — Method in class Breakpoint
- When true, indicates that this is a final result and the breakpoint state will not change from here on.
- Breakpoint::setCreateTime() — Method in class Breakpoint
- Time this breakpoint was created by the server in seconds resolution.
- Breakpoint::setFinalTime() — Method in class Breakpoint
- Time this breakpoint was finalized as seen by the server in seconds resolution.
- Breakpoint::setUserEmail() — Method in class Breakpoint
- E-mail address of the user that created this breakpoint
- Breakpoint::setStatus() — Method in class Breakpoint
- Breakpoint status.
- Breakpoint::setStackFrames() — Method in class Breakpoint
- The stack at breakpoint time.
- Breakpoint::setEvaluatedExpressions() — Method in class Breakpoint
- Values of evaluated expressions at breakpoint time.
- Breakpoint::setVariableTable() — Method in class Breakpoint
- The
variable_tableexists to aid with computation, memory and network traffic optimization. It enables storing a variable once and reference it from multiple variables, including variables stored in thevariable_tableitself. - Breakpoint::setLabels() — Method in class Breakpoint
- A set of custom breakpoint properties, populated by the agent, to be displayed to the user.
- Debuggee::setId() — Method in class Debuggee
- Unique identifier for the debuggee generated by the controller service.
- Debuggee::setProject() — Method in class Debuggee
- Project the debuggee is associated with.
- Debuggee::setUniquifier() — Method in class Debuggee
- Uniquifier to further distiguish the application.
- Debuggee::setDescription() — Method in class Debuggee
- Human readable description of the debuggee.
- Debuggee::setIsInactive() — Method in class Debuggee
- If set to
true, indicates that Controller service does not detect any activity from the debuggee agents and the application is possibly stopped. - Debuggee::setAgentVersion() — Method in class Debuggee
- Version ID of the agent.
- Debuggee::setIsDisabled() — Method in class Debuggee
- If set to
true, indicates that the agent should disable itself and detach from the debuggee. - Debuggee::setStatus() — Method in class Debuggee
- Human readable message to be displayed to the user about this debuggee.
- Debuggee::setSourceContexts() — Method in class Debuggee
- References to the locations and revisions of the source code used in the deployed application.
- Debuggee::setExtSourceContexts() — Method in class Debuggee
- References to the locations and revisions of the source code used in the deployed application.
- Debuggee::setLabels() — Method in class Debuggee
- A set of custom debuggee properties, populated by the agent, to be displayed to the user.
- Debugger2GrpcClient::SetBreakpoint() — Method in class Debugger2GrpcClient
- Sets the breakpoint to the debuggee.
- DeleteBreakpointRequest::setDebuggeeId() — Method in class DeleteBreakpointRequest
- ID of the debuggee whose breakpoint to delete.
- DeleteBreakpointRequest::setBreakpointId() — Method in class DeleteBreakpointRequest
- ID of the breakpoint to delete.
- DeleteBreakpointRequest::setClientVersion() — Method in class DeleteBreakpointRequest
- The client version making the call.
- FormatMessage::setFormat() — Method in class FormatMessage
- Format template for the message. The
formatuses placeholders$0,$1, etc. to reference parameters.$$can be used to denote the$character. - FormatMessage::setParameters() — Method in class FormatMessage
- Optional parameters to be embedded into the message.
- GetBreakpointRequest::setDebuggeeId() — Method in class GetBreakpointRequest
- ID of the debuggee whose breakpoint to get.
- GetBreakpointRequest::setBreakpointId() — Method in class GetBreakpointRequest
- ID of the breakpoint to get.
- GetBreakpointRequest::setClientVersion() — Method in class GetBreakpointRequest
- The client version making the call.
- GetBreakpointResponse::setBreakpoint() — Method in class GetBreakpointResponse
- Complete breakpoint state.
- ListActiveBreakpointsRequest::setDebuggeeId() — Method in class ListActiveBreakpointsRequest
- Identifies the debuggee.
- ListActiveBreakpointsRequest::setWaitToken() — Method in class ListActiveBreakpointsRequest
- A token that, if specified, blocks the method call until the list
of active breakpoints has changed, or a server-selected timeout has
expired. The value should be set from the
next_wait_tokenfield in the last response. The initial value should be set to"init". - ListActiveBreakpointsRequest::setSuccessOnTimeout() — Method in class ListActiveBreakpointsRequest
- If set to
true(recommended), returnsgoogle.rpc.Code.OKstatus and sets thewait_expiredresponse field totruewhen the server-selected timeout has expired. - ListActiveBreakpointsResponse::setBreakpoints() — Method in class ListActiveBreakpointsResponse
- List of all active breakpoints.
- ListActiveBreakpointsResponse::setNextWaitToken() — Method in class ListActiveBreakpointsResponse
- A token that can be used in the next method call to block until the list of breakpoints changes.
- ListActiveBreakpointsResponse::setWaitExpired() — Method in class ListActiveBreakpointsResponse
- If set to
true, indicates that there is no change to the list of active breakpoints and the server-selected timeout has expired. - ListBreakpointsRequest::setDebuggeeId() — Method in class ListBreakpointsRequest
- ID of the debuggee whose breakpoints to list.
- ListBreakpointsRequest::setIncludeAllUsers() — Method in class ListBreakpointsRequest
- When set to
true, the response includes the list of breakpoints set by any user. Otherwise, it includes only breakpoints set by the caller. - ListBreakpointsRequest::setIncludeInactive() — Method in class ListBreakpointsRequest
- When set to
true, the response includes active and inactive breakpoints. Otherwise, it includes only active breakpoints. - ListBreakpointsRequest::setAction() — Method in class ListBreakpointsRequest
- When set, the response includes only breakpoints with the specified action.
- ListBreakpointsRequest::setStripResults() — Method in class ListBreakpointsRequest
- This field is deprecated. The following fields are always stripped out of
the result:
stack_frames,evaluated_expressionsandvariable_table. - ListBreakpointsRequest::setWaitToken() — Method in class ListBreakpointsRequest
- A wait token that, if specified, blocks the call until the breakpoints
list has changed, or a server selected timeout has expired. The value
should be set from the last response. The error code
google.rpc.Code.ABORTED(RPC) is returned on wait timeout, which should be called again with the samewait_token. - ListBreakpointsRequest::setClientVersion() — Method in class ListBreakpointsRequest
- The client version making the call.
- ListBreakpointsRequest_BreakpointActionValue::setValue() — Method in class ListBreakpointsRequest_BreakpointActionValue
- Only breakpoints with the specified action will pass the filter.
- ListBreakpointsResponse::setBreakpoints() — Method in class ListBreakpointsResponse
- List of breakpoints matching the request.
- ListBreakpointsResponse::setNextWaitToken() — Method in class ListBreakpointsResponse
- A wait token that can be used in the next call to
list(REST) orListBreakpoints(RPC) to block until the list of breakpoints has changes. - ListDebuggeesRequest::setProject() — Method in class ListDebuggeesRequest
- Project number of a Google Cloud project whose debuggees to list.
- ListDebuggeesRequest::setIncludeInactive() — Method in class ListDebuggeesRequest
- When set to
true, the result includes all debuggees. Otherwise, the result includes only debuggees that are active. - ListDebuggeesRequest::setClientVersion() — Method in class ListDebuggeesRequest
- The client version making the call.
- ListDebuggeesResponse::setDebuggees() — Method in class ListDebuggeesResponse
- List of debuggees accessible to the calling user.
- RegisterDebuggeeRequest::setDebuggee() — Method in class RegisterDebuggeeRequest
- Debuggee information to register.
- RegisterDebuggeeResponse::setDebuggee() — Method in class RegisterDebuggeeResponse
- Debuggee resource.
- SetBreakpointRequest — Class in namespace Google\Cloud\Debugger\V2
- Request to set a breakpoint
- SetBreakpointRequest::setDebuggeeId() — Method in class SetBreakpointRequest
- ID of the debuggee where the breakpoint is to be set.
- SetBreakpointRequest::setBreakpoint() — Method in class SetBreakpointRequest
- Breakpoint specification to set.
- SetBreakpointRequest::setClientVersion() — Method in class SetBreakpointRequest
- The client version making the call.
- SetBreakpointResponse — Class in namespace Google\Cloud\Debugger\V2
- Response for setting a breakpoint.
- SetBreakpointResponse::setBreakpoint() — Method in class SetBreakpointResponse
- Breakpoint resource.
- SourceLocation — Class in namespace Google\Cloud\Debugger\V2
- Represents a location in the source code.
- SourceLocation::setPath() — Method in class SourceLocation
- Path to the source file within the source context of the target binary.
- SourceLocation::setLine() — Method in class SourceLocation
- Line inside the file. The first line in the file has the value
1. - StackFrame — Class in namespace Google\Cloud\Debugger\V2
- Represents a stack frame context.
- StackFrame::setFunction() — Method in class StackFrame
- Demangled function name at the call site.
- StackFrame::setLocation() — Method in class StackFrame
- Source location of the call site.
- StackFrame::setArguments() — Method in class StackFrame
- Set of arguments passed to this function.
- StackFrame::setLocals() — Method in class StackFrame
- Set of local variables at the stack frame location.
- StatusMessage — Class in namespace Google\Cloud\Debugger\V2
- Represents a contextual status message.
- StatusMessage::setIsError() — Method in class StatusMessage
- Distinguishes errors from informational messages.
- StatusMessage::setRefersTo() — Method in class StatusMessage
- Reference to which the message applies.
- StatusMessage::setDescription() — Method in class StatusMessage
- Status message text.
- StatusMessage_Reference — Class in namespace Google\Cloud\Debugger\V2
- Enumerates references to which the message applies.
- UpdateActiveBreakpointRequest::setDebuggeeId() — Method in class UpdateActiveBreakpointRequest
- Identifies the debuggee being debugged.
- UpdateActiveBreakpointRequest::setBreakpoint() — Method in class UpdateActiveBreakpointRequest
- Updated breakpoint information.
- Variable::setName() — Method in class Variable
- Name of the variable, if any.
- Variable::setValue() — Method in class Variable
- Simple value of the variable.
- Variable::setType() — Method in class Variable
- Variable type (e.g.
MyClass). If the variable is split withvar_table_index,typegoes next tovalue. The interpretation of a type is agent specific. It is recommended to include the dynamic type rather than a static type of an object. - Variable::setMembers() — Method in class Variable
- Members contained or pointed to by the variable.
- Variable::setVarTableIndex() — Method in class Variable
- Reference to a variable in the shared variable table. More than
one variable can reference the same variable in the table. The
var_table_indexfield is an index intovariable_tablein Breakpoint. - Variable::setStatus() — Method in class Variable
- Status associated with the variable. This field will usually stay unset. A status of a single variable only applies to that variable or expression. The rest of breakpoint data still remains valid. Variables might be reported in error state even when breakpoint is not in final state.
- AliasContext::setKind() — Method in class AliasContext
- The alias kind.
- AliasContext::setName() — Method in class AliasContext
- The alias name.
- CloudRepoSourceContext::setRepoId() — Method in class CloudRepoSourceContext
- The ID of the repo.
- CloudRepoSourceContext::setRevisionId() — Method in class CloudRepoSourceContext
- A revision ID.
- CloudRepoSourceContext::setAliasName() — Method in class CloudRepoSourceContext
- The name of an alias (branch, tag, etc.).
- CloudRepoSourceContext::setAliasContext() — Method in class CloudRepoSourceContext
- An alias, which may be a branch or tag.
- CloudWorkspaceId::setRepoId() — Method in class CloudWorkspaceId
- The ID of the repo containing the workspace.
- CloudWorkspaceId::setName() — Method in class CloudWorkspaceId
- The unique name of the workspace within the repo. This is the name chosen by the client in the Source API's CreateWorkspace method.
- CloudWorkspaceSourceContext::setWorkspaceId() — Method in class CloudWorkspaceSourceContext
- The ID of the workspace.
- CloudWorkspaceSourceContext::setSnapshotId() — Method in class CloudWorkspaceSourceContext
- The ID of the snapshot.
- ExtendedSourceContext::setContext() — Method in class ExtendedSourceContext
- Any source context.
- ExtendedSourceContext::setLabels() — Method in class ExtendedSourceContext
- Labels with user defined metadata.
- GerritSourceContext::setHostUri() — Method in class GerritSourceContext
- The URI of a running Gerrit instance.
- GerritSourceContext::setGerritProject() — Method in class GerritSourceContext
- The full project name within the host. Projects may be nested, so "project/subproject" is a valid project name.
- GerritSourceContext::setRevisionId() — Method in class GerritSourceContext
- A revision (commit) ID.
- GerritSourceContext::setAliasName() — Method in class GerritSourceContext
- The name of an alias (branch, tag, etc.).
- GerritSourceContext::setAliasContext() — Method in class GerritSourceContext
- An alias, which may be a branch or tag.
- GitSourceContext::setUrl() — Method in class GitSourceContext
- Git repository URL.
- GitSourceContext::setRevisionId() — Method in class GitSourceContext
- Git commit hash.
- ProjectRepoId::setProjectId() — Method in class ProjectRepoId
- The ID of the project.
- ProjectRepoId::setRepoName() — Method in class ProjectRepoId
- The name of the repo. Leave empty for the default repo.
- RepoId::setProjectRepoId() — Method in class RepoId
- A combination of a project ID and a repo name.
- RepoId::setUid() — Method in class RepoId
- A server-assigned, globally unique identifier.
- SourceContext — Class in namespace Google\Cloud\DevTools\Source\V1
- A SourceContext is a reference to a tree of files. A SourceContext together with a path point to a unique revision of a single file or directory.
- SourceContext::setCloudRepo() — Method in class SourceContext
- A SourceContext referring to a revision in a cloud repo.
- SourceContext::setCloudWorkspace() — Method in class SourceContext
- A SourceContext referring to a snapshot in a cloud workspace.
- SourceContext::setGerrit() — Method in class SourceContext
- A SourceContext referring to a Gerrit project.
- SourceContext::setGit() — Method in class SourceContext
- A SourceContext referring to any third party Git repo (e.g. GitHub).
- Agent::setParent() — Method in class Agent
- Required. The project of this agent.
- Agent::setDisplayName() — Method in class Agent
- Required. The name of this agent.
- Agent::setDefaultLanguageCode() — Method in class Agent
- Required. The default language of the agent as a language tag. See Language Support for a list of the currently supported language codes.
- Agent::setSupportedLanguageCodes() — Method in class Agent
- Optional. The list of all languages supported by this agent (except for the
default_language_code). - Agent::setTimeZone() — Method in class Agent
- Required. The time zone of this agent from the time zone database, e.g., America/New_York, Europe/Paris.
- Agent::setDescription() — Method in class Agent
- Optional. The description of this agent.
- Agent::setAvatarUri() — Method in class Agent
- Optional. The URI of the agent's avatar.
- Agent::setEnableLogging() — Method in class Agent
- Optional. Determines whether this agent should log conversation queries.
- Agent::setMatchMode() — Method in class Agent
- Optional. Determines how intents are detected from user queries.
- Agent::setClassificationThreshold() — Method in class Agent
- Optional. To filter out false positive results and still get variety in matched natural language inputs for your agent, you can tune the machine learning classification threshold. If the returned score value is less than the threshold value, then a fallback intent is be triggered or, if there are no fallback intents defined, no intent will be triggered. The score values range from 0.0 (completely uncertain) to 1.0 (completely certain).
- AgentsGrpcClient::SearchAgents() — Method in class AgentsGrpcClient
- Returns the list of agents.
- BatchCreateEntitiesRequest::setParent() — Method in class BatchCreateEntitiesRequest
- Required. The name of the entity type to create entities in. Format:
projects/<Project ID>/agent/entityTypes/<Entity Type ID>. - BatchCreateEntitiesRequest::setEntities() — Method in class BatchCreateEntitiesRequest
- Required. The collection of entities to create.
- BatchCreateEntitiesRequest::setLanguageCode() — Method in class BatchCreateEntitiesRequest
- Optional. The language of entity synonyms defined in
entities. If not specified, the agent's default language is used. - BatchDeleteEntitiesRequest::setParent() — Method in class BatchDeleteEntitiesRequest
- Required. The name of the entity type to delete entries for. Format:
projects/<Project ID>/agent/entityTypes/<Entity Type ID>. - BatchDeleteEntitiesRequest::setEntityValues() — Method in class BatchDeleteEntitiesRequest
- Required. The canonical
valuesof the entities to delete. Note that these are not fully-qualified names, i.e. they don't start withprojects/<Project ID>. - BatchDeleteEntitiesRequest::setLanguageCode() — Method in class BatchDeleteEntitiesRequest
- Optional. The language of entity synonyms defined in
entities. If not specified, the agent's default language is used. - BatchDeleteEntityTypesRequest::setParent() — Method in class BatchDeleteEntityTypesRequest
- Required. The name of the agent to delete all entities types for. Format:
projects/<Project ID>/agent. - BatchDeleteEntityTypesRequest::setEntityTypeNames() — Method in class BatchDeleteEntityTypesRequest
- Required. The names entity types to delete. All names must point to the
same agent as
parent. - BatchDeleteIntentsRequest::setParent() — Method in class BatchDeleteIntentsRequest
- Required. The name of the agent to delete all entities types for. Format:
projects/<Project ID>/agent. - BatchDeleteIntentsRequest::setIntents() — Method in class BatchDeleteIntentsRequest
- Required. The collection of intents to delete. Only intent
namemust be filled in. - BatchUpdateEntitiesRequest::setParent() — Method in class BatchUpdateEntitiesRequest
- Required. The name of the entity type to update the entities in. Format:
projects/<Project ID>/agent/entityTypes/<Entity Type ID>. - BatchUpdateEntitiesRequest::setEntities() — Method in class BatchUpdateEntitiesRequest
- Required. The collection of new entities to replace the existing entities.
- BatchUpdateEntitiesRequest::setLanguageCode() — Method in class BatchUpdateEntitiesRequest
- Optional. The language of entity synonyms defined in
entities. If not specified, the agent's default language is used. - BatchUpdateEntitiesRequest::setUpdateMask() — Method in class BatchUpdateEntitiesRequest
- Optional. The mask to control which fields get updated.
- BatchUpdateEntityTypesRequest::setParent() — Method in class BatchUpdateEntityTypesRequest
- Required. The name of the agent to update or create entity types in.
- BatchUpdateEntityTypesRequest::setEntityTypeBatchUri() — Method in class BatchUpdateEntityTypesRequest
- The URI to a Google Cloud Storage file containing entity types to update or create. The file format can either be a serialized proto (of EntityBatch type) or a JSON object. Note: The URI must start with "gs://".
- BatchUpdateEntityTypesRequest::setEntityTypeBatchInline() — Method in class BatchUpdateEntityTypesRequest
- The collection of entity type to update or create.
- BatchUpdateEntityTypesRequest::setLanguageCode() — Method in class BatchUpdateEntityTypesRequest
- Optional. The language of entity synonyms defined in
entity_types. If not specified, the agent's default language is used. - BatchUpdateEntityTypesRequest::setUpdateMask() — Method in class BatchUpdateEntityTypesRequest
- Optional. The mask to control which fields get updated.
- BatchUpdateEntityTypesResponse::setEntityTypes() — Method in class BatchUpdateEntityTypesResponse
- The collection of updated or created entity types.
- BatchUpdateIntentsRequest::setParent() — Method in class BatchUpdateIntentsRequest
- Required. The name of the agent to update or create intents in.
- BatchUpdateIntentsRequest::setIntentBatchUri() — Method in class BatchUpdateIntentsRequest
- The URI to a Google Cloud Storage file containing intents to update or create. The file format can either be a serialized proto (of IntentBatch type) or JSON object. Note: The URI must start with "gs://".
- BatchUpdateIntentsRequest::setIntentBatchInline() — Method in class BatchUpdateIntentsRequest
- The collection of intents to update or create.
- BatchUpdateIntentsRequest::setLanguageCode() — Method in class BatchUpdateIntentsRequest
- Optional. The language of training phrases, parameters and rich messages
defined in
intents. If not specified, the agent's default language is used. More than a dozen languages are supported. - BatchUpdateIntentsRequest::setUpdateMask() — Method in class BatchUpdateIntentsRequest
- Optional. The mask to control which fields get updated.
- BatchUpdateIntentsRequest::setIntentView() — Method in class BatchUpdateIntentsRequest
- Optional. The resource view to apply to the returned intent.
- BatchUpdateIntentsResponse::setIntents() — Method in class BatchUpdateIntentsResponse
- The collection of updated or created intents.
- Context::setName() — Method in class Context
- Required. The unique identifier of the context. Format:
projects/<Project ID>/agent/sessions/<Session ID>/contexts/<Context ID>. - Context::setLifespanCount() — Method in class Context
- Optional. The number of conversational query requests after which the
context expires. If set to
0(the default) the context expires immediately. Contexts expire automatically after 10 minutes even if there are no matching queries. - Context::setParameters() — Method in class Context
- Optional. The collection of parameters associated with this context.
- CreateContextRequest::setParent() — Method in class CreateContextRequest
- Required. The session to create a context for.
- CreateContextRequest::setContext() — Method in class CreateContextRequest
- Required. The context to create.
- CreateEntityTypeRequest::setParent() — Method in class CreateEntityTypeRequest
- Required. The agent to create a entity type for.
- CreateEntityTypeRequest::setEntityType() — Method in class CreateEntityTypeRequest
- Required. The entity type to create.
- CreateEntityTypeRequest::setLanguageCode() — Method in class CreateEntityTypeRequest
- Optional. The language of entity synonyms defined in
entity_type. If not specified, the agent's default language is used. - CreateIntentRequest::setParent() — Method in class CreateIntentRequest
- Required. The agent to create a intent for.
- CreateIntentRequest::setIntent() — Method in class CreateIntentRequest
- Required. The intent to create.
- CreateIntentRequest::setLanguageCode() — Method in class CreateIntentRequest
- Optional. The language of training phrases, parameters and rich messages
defined in
intent. If not specified, the agent's default language is used. More than a dozen languages are supported. - CreateIntentRequest::setIntentView() — Method in class CreateIntentRequest
- Optional. The resource view to apply to the returned intent.
- CreateSessionEntityTypeRequest::setParent() — Method in class CreateSessionEntityTypeRequest
- Required. The session to create a session entity type for.
- CreateSessionEntityTypeRequest::setSessionEntityType() — Method in class CreateSessionEntityTypeRequest
- Required. The session entity type to create.
- DeleteAllContextsRequest::setParent() — Method in class DeleteAllContextsRequest
- Required. The name of the session to delete all contexts from. Format:
projects/<Project ID>/agent/sessions/<Session ID>. - DeleteContextRequest::setName() — Method in class DeleteContextRequest
- Required. The name of the context to delete. Format:
projects/<Project ID>/agent/sessions/<Session ID>/contexts/<Context ID>. - DeleteEntityTypeRequest::setName() — Method in class DeleteEntityTypeRequest
- Required. The name of the entity type to delete.
- DeleteIntentRequest::setName() — Method in class DeleteIntentRequest
- Required. The name of the intent to delete.
- DeleteSessionEntityTypeRequest::setName() — Method in class DeleteSessionEntityTypeRequest
- Required. The name of the entity type to delete. Format:
projects/<Project ID>/agent/sessions/<Session ID>/entityTypes/<Entity Type Display Name>. - DetectIntentRequest::setSession() — Method in class DetectIntentRequest
- Required. The name of the session this query is sent to. Format:
projects/<Project ID>/agent/sessions/<Session ID>. It's up to the API caller to choose an appropriate session ID. It can be a random number or some type of user identifier (preferably hashed). The length of the session ID must not exceed 36 bytes. - DetectIntentRequest::setQueryParams() — Method in class DetectIntentRequest
- Optional. The parameters of this query.
- DetectIntentRequest::setQueryInput() — Method in class DetectIntentRequest
- Required. The input specification. It can be set to: 1. an audio config which instructs the speech recognizer how to process the speech audio, 2. a conversational query in the form of text, or 3. an event that specifies which intent to trigger.
- DetectIntentRequest::setInputAudio() — Method in class DetectIntentRequest
- Optional. The natural language speech audio to be processed. This field
should be populated iff
query_inputis set to an input audio config. - DetectIntentResponse::setResponseId() — Method in class DetectIntentResponse
- The unique identifier of the response. It can be used to locate a response in the training example set or for reporting issues.
- DetectIntentResponse::setQueryResult() — Method in class DetectIntentResponse
- The results of the conversational query or event processing.
- DetectIntentResponse::setWebhookStatus() — Method in class DetectIntentResponse
- Specifies the status of the webhook request.
webhook_statusis never populated in webhook requests. - EntityType::setName() — Method in class EntityType
- Required for all methods except
create(createpopulates the name automatically. - EntityType::setDisplayName() — Method in class EntityType
- Required. The name of the entity.
- EntityType::setKind() — Method in class EntityType
- Required. Indicates the kind of entity type.
- EntityType::setAutoExpansionMode() — Method in class EntityType
- Optional. Indicates whether the entity type can be automatically expanded.
- EntityType::setEntities() — Method in class EntityType
- Optional. The collection of entities associated with the entity type.
- EntityTypeBatch::setEntityTypes() — Method in class EntityTypeBatch
- A collection of entity types.
- EntityType_Entity::setValue() — Method in class EntityType_Entity
- Required.
- EntityType_Entity::setSynonyms() — Method in class EntityType_Entity
- Required. A collection of synonyms. For
KIND_LISTentity types this must contain exactly one synonym equal tovalue. - EventInput::setName() — Method in class EventInput
- Required. The unique identifier of the event.
- EventInput::setParameters() — Method in class EventInput
- Optional. The collection of parameters associated with the event.
- EventInput::setLanguageCode() — Method in class EventInput
- Required. The language of this query. See Language Support for a list of the currently supported language codes. Note that queries in the same session do not necessarily need to specify the same language.
- ExportAgentRequest::setParent() — Method in class ExportAgentRequest
- Required. The project that the agent to export is associated with.
- ExportAgentRequest::setAgentUri() — Method in class ExportAgentRequest
- Optional. The Google Cloud Storage URI to export the agent to.
- ExportAgentResponse::setAgentUri() — Method in class ExportAgentResponse
- The URI to a file containing the exported agent. This field is populated
only if
agent_uriis specified inExportAgentRequest. - ExportAgentResponse::setAgentContent() — Method in class ExportAgentResponse
- The exported agent.
- GetAgentRequest::setParent() — Method in class GetAgentRequest
- Required. The project that the agent to fetch is associated with.
- GetContextRequest::setName() — Method in class GetContextRequest
- Required. The name of the context. Format:
projects/<Project ID>/agent/sessions/<Session ID>/contexts/<Context ID>. - GetEntityTypeRequest::setName() — Method in class GetEntityTypeRequest
- Required. The name of the entity type.
- GetEntityTypeRequest::setLanguageCode() — Method in class GetEntityTypeRequest
- Optional. The language to retrieve entity synonyms for. If not specified, the agent's default language is used.
- GetIntentRequest::setName() — Method in class GetIntentRequest
- Required. The name of the intent.
- GetIntentRequest::setLanguageCode() — Method in class GetIntentRequest
- Optional. The language to retrieve training phrases, parameters and rich messages for. If not specified, the agent's default language is used.
- GetIntentRequest::setIntentView() — Method in class GetIntentRequest
- Optional. The resource view to apply to the returned intent.
- GetSessionEntityTypeRequest::setName() — Method in class GetSessionEntityTypeRequest
- Required. The name of the session entity type. Format:
projects/<Project ID>/agent/sessions/<Session ID>/entityTypes/<Entity Type Display Name>. - ImportAgentRequest::setParent() — Method in class ImportAgentRequest
- Required. The project that the agent to import is associated with.
- ImportAgentRequest::setAgentUri() — Method in class ImportAgentRequest
- The URI to a Google Cloud Storage file containing the agent to import.
- ImportAgentRequest::setAgentContent() — Method in class ImportAgentRequest
- The agent to import.
- InputAudioConfig::setAudioEncoding() — Method in class InputAudioConfig
- Required. Audio encoding of the audio content to process.
- InputAudioConfig::setSampleRateHertz() — Method in class InputAudioConfig
- Required. Sample rate (in Hertz) of the audio content sent in the query.
- InputAudioConfig::setLanguageCode() — Method in class InputAudioConfig
- Required. The language of the supplied audio. Dialogflow does not do translations. See Language Support for a list of the currently supported language codes. Note that queries in the same session do not necessarily need to specify the same language.
- InputAudioConfig::setPhraseHints() — Method in class InputAudioConfig
- Optional. The collection of phrase hints which are used to boost accuracy of speech recognition.
- Intent::setName() — Method in class Intent
- Required for all methods except
create(createpopulates the name automatically. - Intent::setDisplayName() — Method in class Intent
- Required. The name of this intent.
- Intent::setWebhookState() — Method in class Intent
- Required. Indicates whether webhooks are enabled for the intent.
- Intent::setPriority() — Method in class Intent
- Optional. The priority of this intent. Higher numbers represent higher priorities. Zero or negative numbers mean that the intent is disabled.
- Intent::setIsFallback() — Method in class Intent
- Optional. Indicates whether this is a fallback intent.
- Intent::setMlDisabled() — Method in class Intent
- Optional. Indicates whether Machine Learning is disabled for the intent.
- Intent::setInputContextNames() — Method in class Intent
- Optional. The list of context names required for this intent to be triggered.
- Intent::setEvents() — Method in class Intent
- Optional. The collection of event names that trigger the intent.
- Intent::setTrainingPhrases() — Method in class Intent
- Optional. The collection of examples/templates that the agent is trained on.
- Intent::setAction() — Method in class Intent
- Optional. The name of the action associated with the intent.
- Intent::setOutputContexts() — Method in class Intent
- Optional. The collection of contexts that are activated when the intent
is matched. Context messages in this collection should not set the
parameters field. Setting the
lifespan_countto 0 will reset the context when the intent is matched. - Intent::setResetContexts() — Method in class Intent
- Optional. Indicates whether to delete all contexts in the current session when this intent is matched.
- Intent::setParameters() — Method in class Intent
- Optional. The collection of parameters associated with the intent.
- Intent::setMessages() — Method in class Intent
- Optional. The collection of rich messages corresponding to the
Responsefield in the Dialogflow console. - Intent::setDefaultResponsePlatforms() — Method in class Intent
- Optional. The list of platforms for which the first response will be taken from among the messages assigned to the DEFAULT_PLATFORM.
- Intent::setRootFollowupIntentName() — Method in class Intent
- The unique identifier of the root intent in the chain of followup intents.
- Intent::setParentFollowupIntentName() — Method in class Intent
- The unique identifier of the parent intent in the chain of followup intents.
- Intent::setFollowupIntentInfo() — Method in class Intent
- Optional. Collection of information about all followup intents that have name of this intent as a root_name.
- IntentBatch::setIntents() — Method in class IntentBatch
- A collection of intents.
- Intent_FollowupIntentInfo::setFollowupIntentName() — Method in class Intent_FollowupIntentInfo
- The unique identifier of the followup intent.
- Intent_FollowupIntentInfo::setParentFollowupIntentName() — Method in class Intent_FollowupIntentInfo
- The unique identifier of the followup intent parent.
- Intent_Message::setText() — Method in class Intent_Message
- The text response.
- Intent_Message::setImage() — Method in class Intent_Message
- The image response.
- Intent_Message::setQuickReplies() — Method in class Intent_Message
- The quick replies response.
- Intent_Message::setCard() — Method in class Intent_Message
- The card response.
- Intent_Message::setPayload() — Method in class Intent_Message
- Returns a response containing a custom, platform-specific payload.
- Intent_Message::setSimpleResponses() — Method in class Intent_Message
- The voice and text-only responses for Actions on Google.
- Intent_Message::setBasicCard() — Method in class Intent_Message
- The basic card response for Actions on Google.
- Intent_Message::setSuggestions() — Method in class Intent_Message
- The suggestion chips for Actions on Google.
- Intent_Message::setLinkOutSuggestion() — Method in class Intent_Message
- The link out suggestion chip for Actions on Google.
- Intent_Message::setListSelect() — Method in class Intent_Message
- The list card response for Actions on Google.
- Intent_Message::setCarouselSelect() — Method in class Intent_Message
- The carousel card response for Actions on Google.
- Intent_Message::setPlatform() — Method in class Intent_Message
- Optional. The platform that this message is intended for.
- Intent_Message_BasicCard::setTitle() — Method in class Intent_Message_BasicCard
- Optional. The title of the card.
- Intent_Message_BasicCard::setSubtitle() — Method in class Intent_Message_BasicCard
- Optional. The subtitle of the card.
- Intent_Message_BasicCard::setFormattedText() — Method in class Intent_Message_BasicCard
- Required, unless image is present. The body text of the card.
- Intent_Message_BasicCard::setImage() — Method in class Intent_Message_BasicCard
- Optional. The image for the card.
- Intent_Message_BasicCard::setButtons() — Method in class Intent_Message_BasicCard
- Optional. The collection of card buttons.
- Intent_Message_BasicCard_Button::setTitle() — Method in class Intent_Message_BasicCard_Button
- Required. The title of the button.
- Intent_Message_BasicCard_Button::setOpenUriAction() — Method in class Intent_Message_BasicCard_Button
- Required. Action to take when a user taps on the button.
- Intent_Message_BasicCard_Button_OpenUriAction::setUri() — Method in class Intent_Message_BasicCard_Button_OpenUriAction
- Required. The HTTP or HTTPS scheme URI.
- Intent_Message_Card::setTitle() — Method in class Intent_Message_Card
- Optional. The title of the card.
- Intent_Message_Card::setSubtitle() — Method in class Intent_Message_Card
- Optional. The subtitle of the card.
- Intent_Message_Card::setImageUri() — Method in class Intent_Message_Card
- Optional. The public URI to an image file for the card.
- Intent_Message_Card::setButtons() — Method in class Intent_Message_Card
- Optional. The collection of card buttons.
- Intent_Message_Card_Button::setText() — Method in class Intent_Message_Card_Button
- Optional. The text to show on the button.
- Intent_Message_Card_Button::setPostback() — Method in class Intent_Message_Card_Button
- Optional. The text to send back to the Dialogflow API or a URI to open.
- Intent_Message_CarouselSelect::setItems() — Method in class Intent_Message_CarouselSelect
- Required. Carousel items.
- Intent_Message_CarouselSelect_Item::setInfo() — Method in class Intent_Message_CarouselSelect_Item
- Required. Additional info about the option item.
- Intent_Message_CarouselSelect_Item::setTitle() — Method in class Intent_Message_CarouselSelect_Item
- Required. Title of the carousel item.
- Intent_Message_CarouselSelect_Item::setDescription() — Method in class Intent_Message_CarouselSelect_Item
- Optional. The body text of the card.
- Intent_Message_CarouselSelect_Item::setImage() — Method in class Intent_Message_CarouselSelect_Item
- Optional. The image to display.
- Intent_Message_Image::setImageUri() — Method in class Intent_Message_Image
- Optional. The public URI to an image file.
- Intent_Message_Image::setAccessibilityText() — Method in class Intent_Message_Image
- Optional. A text description of the image to be used for accessibility, e.g., screen readers.
- Intent_Message_LinkOutSuggestion::setDestinationName() — Method in class Intent_Message_LinkOutSuggestion
- Required. The name of the app or site this chip is linking to.
- Intent_Message_LinkOutSuggestion::setUri() — Method in class Intent_Message_LinkOutSuggestion
- Required. The URI of the app or site to open when the user taps the suggestion chip.
- Intent_Message_ListSelect::setTitle() — Method in class Intent_Message_ListSelect
- Optional. The overall title of the list.
- Intent_Message_ListSelect::setItems() — Method in class Intent_Message_ListSelect
- Required. List items.
- Intent_Message_ListSelect_Item::setInfo() — Method in class Intent_Message_ListSelect_Item
- Required. Additional information about this option.
- Intent_Message_ListSelect_Item::setTitle() — Method in class Intent_Message_ListSelect_Item
- Required. The title of the list item.
- Intent_Message_ListSelect_Item::setDescription() — Method in class Intent_Message_ListSelect_Item
- Optional. The main text describing the item.
- Intent_Message_ListSelect_Item::setImage() — Method in class Intent_Message_ListSelect_Item
- Optional. The image to display.
- Intent_Message_QuickReplies::setTitle() — Method in class Intent_Message_QuickReplies
- Optional. The title of the collection of quick replies.
- Intent_Message_QuickReplies::setQuickReplies() — Method in class Intent_Message_QuickReplies
- Optional. The collection of quick replies.
- Intent_Message_SelectItemInfo::setKey() — Method in class Intent_Message_SelectItemInfo
- Required. A unique key that will be sent back to the agent if this response is given.
- Intent_Message_SelectItemInfo::setSynonyms() — Method in class Intent_Message_SelectItemInfo
- Optional. A list of synonyms that can also be used to trigger this item in dialog.
- Intent_Message_SimpleResponse::setTextToSpeech() — Method in class Intent_Message_SimpleResponse
- One of text_to_speech or ssml must be provided. The plain text of the speech output. Mutually exclusive with ssml.
- Intent_Message_SimpleResponse::setSsml() — Method in class Intent_Message_SimpleResponse
- One of text_to_speech or ssml must be provided. Structured spoken response to the user in the SSML format. Mutually exclusive with text_to_speech.
- Intent_Message_SimpleResponse::setDisplayText() — Method in class Intent_Message_SimpleResponse
- Optional. The text to display.
- Intent_Message_SimpleResponses::setSimpleResponses() — Method in class Intent_Message_SimpleResponses
- Required. The list of simple responses.
- Intent_Message_Suggestion::setTitle() — Method in class Intent_Message_Suggestion
- Required. The text shown the in the suggestion chip.
- Intent_Message_Suggestions::setSuggestions() — Method in class Intent_Message_Suggestions
- Required. The list of suggested replies.
- Intent_Message_Text::setText() — Method in class Intent_Message_Text
- Optional. The collection of the agent's responses.
- Intent_Parameter::setName() — Method in class Intent_Parameter
- The unique identifier of this parameter.
- Intent_Parameter::setDisplayName() — Method in class Intent_Parameter
- Required. The name of the parameter.
- Intent_Parameter::setValue() — Method in class Intent_Parameter
- Optional. The definition of the parameter value. It can be:
- a constant string,
- a parameter value defined as
$parameter_name, - an original parameter value defined as$parameter_name.original, - a parameter value from some context defined as#context_name.parameter_name. - Intent_Parameter::setDefaultValue() — Method in class Intent_Parameter
- Optional. The default value to use when the
valueyields an empty result. - Intent_Parameter::setEntityTypeDisplayName() — Method in class Intent_Parameter
- Optional. The name of the entity type, prefixed with
@, that describes values of the parameter. If the parameter is required, this must be provided. - Intent_Parameter::setMandatory() — Method in class Intent_Parameter
- Optional. Indicates whether the parameter is required. That is, whether the intent cannot be completed without collecting the parameter value.
- Intent_Parameter::setPrompts() — Method in class Intent_Parameter
- Optional. The collection of prompts that the agent can present to the user in order to collect value for the parameter.
- Intent_Parameter::setIsList() — Method in class Intent_Parameter
- Optional. Indicates whether the parameter represents a list of values.
- Intent_TrainingPhrase::setName() — Method in class Intent_TrainingPhrase
- Required. The unique identifier of this training phrase.
- Intent_TrainingPhrase::setType() — Method in class Intent_TrainingPhrase
- Required. The type of the training phrase.
- Intent_TrainingPhrase::setParts() — Method in class Intent_TrainingPhrase
- Required. The collection of training phrase parts (can be annotated).
- Intent_TrainingPhrase::setTimesAddedCount() — Method in class Intent_TrainingPhrase
- Optional. Indicates how many times this example or template was added to the intent. Each time a developer adds an existing sample by editing an intent or training, this counter is increased.
- Intent_TrainingPhrase_Part::setText() — Method in class Intent_TrainingPhrase_Part
- Required. The text corresponding to the example or template, if there are no annotations. For annotated examples, it is the text for one of the example's parts.
- Intent_TrainingPhrase_Part::setEntityType() — Method in class Intent_TrainingPhrase_Part
- Optional. The entity type name prefixed with
@. This field is required for the annotated part of the text and applies only to examples. - Intent_TrainingPhrase_Part::setAlias() — Method in class Intent_TrainingPhrase_Part
- Optional. The parameter name for the value extracted from the annotated part of the example.
- Intent_TrainingPhrase_Part::setUserDefined() — Method in class Intent_TrainingPhrase_Part
- Optional. Indicates whether the text was manually annotated by the developer.
- ListContextsRequest::setParent() — Method in class ListContextsRequest
- Required. The session to list all contexts from.
- ListContextsRequest::setPageSize() — Method in class ListContextsRequest
- Optional. The maximum number of items to return in a single page. By default 100 and at most 1000.
- ListContextsRequest::setPageToken() — Method in class ListContextsRequest
- Optional. The next_page_token value returned from a previous list request.
- ListContextsResponse::setContexts() — Method in class ListContextsResponse
- The list of contexts. There will be a maximum number of items returned based on the page_size field in the request.
- ListContextsResponse::setNextPageToken() — Method in class ListContextsResponse
- Token to retrieve the next page of results, or empty if there are no more results in the list.
- ListEntityTypesRequest::setParent() — Method in class ListEntityTypesRequest
- Required. The agent to list all entity types from.
- ListEntityTypesRequest::setLanguageCode() — Method in class ListEntityTypesRequest
- Optional. The language to list entity synonyms for. If not specified, the agent's default language is used.
- ListEntityTypesRequest::setPageSize() — Method in class ListEntityTypesRequest
- Optional. The maximum number of items to return in a single page. By default 100 and at most 1000.
- ListEntityTypesRequest::setPageToken() — Method in class ListEntityTypesRequest
- Optional. The next_page_token value returned from a previous list request.
- ListEntityTypesResponse::setEntityTypes() — Method in class ListEntityTypesResponse
- The list of agent entity types. There will be a maximum number of items returned based on the page_size field in the request.
- ListEntityTypesResponse::setNextPageToken() — Method in class ListEntityTypesResponse
- Token to retrieve the next page of results, or empty if there are no more results in the list.
- ListIntentsRequest::setParent() — Method in class ListIntentsRequest
- Required. The agent to list all intents from.
- ListIntentsRequest::setLanguageCode() — Method in class ListIntentsRequest
- Optional. The language to list training phrases, parameters and rich messages for. If not specified, the agent's default language is used.
- ListIntentsRequest::setIntentView() — Method in class ListIntentsRequest
- Optional. The resource view to apply to the returned intent.
- ListIntentsRequest::setPageSize() — Method in class ListIntentsRequest
- Optional. The maximum number of items to return in a single page. By default 100 and at most 1000.
- ListIntentsRequest::setPageToken() — Method in class ListIntentsRequest
- Optional. The next_page_token value returned from a previous list request.
- ListIntentsResponse::setIntents() — Method in class ListIntentsResponse
- The list of agent intents. There will be a maximum number of items returned based on the page_size field in the request.
- ListIntentsResponse::setNextPageToken() — Method in class ListIntentsResponse
- Token to retrieve the next page of results, or empty if there are no more results in the list.
- ListSessionEntityTypesRequest::setParent() — Method in class ListSessionEntityTypesRequest
- Required. The session to list all session entity types from.
- ListSessionEntityTypesRequest::setPageSize() — Method in class ListSessionEntityTypesRequest
- Optional. The maximum number of items to return in a single page. By default 100 and at most 1000.
- ListSessionEntityTypesRequest::setPageToken() — Method in class ListSessionEntityTypesRequest
- Optional. The next_page_token value returned from a previous list request.
- ListSessionEntityTypesResponse::setSessionEntityTypes() — Method in class ListSessionEntityTypesResponse
- The list of session entity types. There will be a maximum number of items returned based on the page_size field in the request.
- ListSessionEntityTypesResponse::setNextPageToken() — Method in class ListSessionEntityTypesResponse
- Token to retrieve the next page of results, or empty if there are no more results in the list.
- OriginalDetectIntentRequest::setSource() — Method in class OriginalDetectIntentRequest
- The source of this request, e.g.,
google,facebook,slack. It is set by Dialogflow-owned servers. - OriginalDetectIntentRequest::setPayload() — Method in class OriginalDetectIntentRequest
- Optional. This field is set to the value of
QueryParameters.payloadfield passed in the request. - QueryInput::setAudioConfig() — Method in class QueryInput
- Instructs the speech recognizer how to process the speech audio.
- QueryInput::setText() — Method in class QueryInput
- The natural language text to be processed.
- QueryInput::setEvent() — Method in class QueryInput
- The event to be processed.
- QueryParameters::setTimeZone() — Method in class QueryParameters
- Optional. The time zone of this conversational query from the time zone database, e.g., America/New_York, Europe/Paris. If not provided, the time zone specified in agent settings is used.
- QueryParameters::setGeoLocation() — Method in class QueryParameters
- Optional. The geo location of this conversational query.
- QueryParameters::setContexts() — Method in class QueryParameters
- Optional. The collection of contexts to be activated before this query is executed.
- QueryParameters::setResetContexts() — Method in class QueryParameters
- Optional. Specifies whether to delete all contexts in the current session before the new ones are activated.
- QueryParameters::setSessionEntityTypes() — Method in class QueryParameters
- Optional. The collection of session entity types to replace or extend developer entities with for this query only. The entity synonyms apply to all languages.
- QueryParameters::setPayload() — Method in class QueryParameters
- Optional. This field can be used to pass custom data into the webhook associated with the agent. Arbitrary JSON objects are supported.
- QueryResult::setQueryText() — Method in class QueryResult
- The original conversational query text:
- If natural language text was provided as input,
query_textcontains a copy of the input. - QueryResult::setLanguageCode() — Method in class QueryResult
- The language that was triggered during intent detection.
- QueryResult::setSpeechRecognitionConfidence() — Method in class QueryResult
- The Speech recognition confidence between 0.0 and 1.0. A higher number indicates an estimated greater likelihood that the recognized words are correct. The default of 0.0 is a sentinel value indicating that confidence was not set.
- QueryResult::setAction() — Method in class QueryResult
- The action name from the matched intent.
- QueryResult::setParameters() — Method in class QueryResult
- The collection of extracted parameters.
- QueryResult::setAllRequiredParamsPresent() — Method in class QueryResult
- This field is set to:
-
falseif the matched intent has required parameters and not all of the required parameter values have been collected. - QueryResult::setFulfillmentText() — Method in class QueryResult
- The text to be pronounced to the user or shown on the screen.
- QueryResult::setFulfillmentMessages() — Method in class QueryResult
- The collection of rich messages to present to the user.
- QueryResult::setWebhookSource() — Method in class QueryResult
- If the query was fulfilled by a webhook call, this field is set to the
value of the
sourcefield returned in the webhook response. - QueryResult::setWebhookPayload() — Method in class QueryResult
- If the query was fulfilled by a webhook call, this field is set to the
value of the
payloadfield returned in the webhook response. - QueryResult::setOutputContexts() — Method in class QueryResult
- The collection of output contexts. If applicable,
output_contexts.parameterscontains entries with name<parameter name>.originalcontaining the original parameter values before the query. - QueryResult::setIntent() — Method in class QueryResult
- The intent that matched the conversational query. Some, not
all fields are filled in this message, including but not limited to:
name,display_nameandwebhook_state. - QueryResult::setIntentDetectionConfidence() — Method in class QueryResult
- The intent detection confidence. Values range from 0.0 (completely uncertain) to 1.0 (completely certain).
- QueryResult::setDiagnosticInfo() — Method in class QueryResult
- The free-form diagnostic info. For example, this field could contain webhook call latency.
- RestoreAgentRequest::setParent() — Method in class RestoreAgentRequest
- Required. The project that the agent to restore is associated with.
- RestoreAgentRequest::setAgentUri() — Method in class RestoreAgentRequest
- The URI to a Google Cloud Storage file containing the agent to restore.
- RestoreAgentRequest::setAgentContent() — Method in class RestoreAgentRequest
- The agent to restore.
- SearchAgentsRequest — Class in namespace Google\Cloud\Dialogflow\V2
- The request message for [Agents.SearchAgents][google.cloud.dialogflow.v2.Agents.SearchAgents].
- SearchAgentsRequest::setParent() — Method in class SearchAgentsRequest
- Required. The project to list agents from.
- SearchAgentsRequest::setPageSize() — Method in class SearchAgentsRequest
- Optional. The maximum number of items to return in a single page. By default 100 and at most 1000.
- SearchAgentsRequest::setPageToken() — Method in class SearchAgentsRequest
- Optional. The next_page_token value returned from a previous list request.
- SearchAgentsResponse — Class in namespace Google\Cloud\Dialogflow\V2
- The response message for [Agents.SearchAgents][google.cloud.dialogflow.v2.Agents.SearchAgents].
- SearchAgentsResponse::setAgents() — Method in class SearchAgentsResponse
- The list of agents. There will be a maximum number of items returned based on the page_size field in the request.
- SearchAgentsResponse::setNextPageToken() — Method in class SearchAgentsResponse
- Token to retrieve the next page of results, or empty if there are no more results in the list.
- SessionEntityType — Class in namespace Google\Cloud\Dialogflow\V2
- Represents a session entity type.
- SessionEntityType::setName() — Method in class SessionEntityType
- Required. The unique identifier of this session entity type. Format:
projects/<Project ID>/agent/sessions/<Session ID>/entityTypes/<Entity Type Display Name>. - SessionEntityType::setEntityOverrideMode() — Method in class SessionEntityType
- Required. Indicates whether the additional data should override or supplement the developer entity type definition.
- SessionEntityType::setEntities() — Method in class SessionEntityType
- Required. The collection of entities associated with this session entity type.
- SessionEntityType_EntityOverrideMode — Class in namespace Google\Cloud\Dialogflow\V2
- The types of modifications for a session entity type.
- SessionEntityTypesGrpcClient — Class in namespace Google\Cloud\Dialogflow\V2
- Entities are extracted from user input and represent parameters that are meaningful to your application. For example, a date range, a proper name such as a geographic location or landmark, and so on. Entities represent actionable data for your application.
- SessionsGrpcClient — Class in namespace Google\Cloud\Dialogflow\V2
- A session represents an interaction with a user. You retrieve user input and pass it to the [DetectIntent][google.cloud.dialogflow.v2.Sessions.DetectIntent] (or [StreamingDetectIntent][google.cloud.dialogflow.v2.Sessions.StreamingDetectIntent]) method to determine user intent and respond.
- SessionsGrpcClient::StreamingDetectIntent() — Method in class SessionsGrpcClient
- Processes a natural language query in audio format in a streaming fashion and returns structured, actionable data as a result. This method is only available via the gRPC API (not REST).
- StreamingDetectIntentRequest — Class in namespace Google\Cloud\Dialogflow\V2
- The top-level message sent by the client to the
StreamingDetectIntentmethod. - StreamingDetectIntentRequest::setSession() — Method in class StreamingDetectIntentRequest
- Required. The name of the session the query is sent to.
- StreamingDetectIntentRequest::setQueryParams() — Method in class StreamingDetectIntentRequest
- Optional. The parameters of this query.
- StreamingDetectIntentRequest::setQueryInput() — Method in class StreamingDetectIntentRequest
- Required. The input specification. It can be set to: 1. an audio config which instructs the speech recognizer how to process the speech audio, 2. a conversational query in the form of text, or 3. an event that specifies which intent to trigger.
- StreamingDetectIntentRequest::setSingleUtterance() — Method in class StreamingDetectIntentRequest
- Optional. If
false(default), recognition does not cease until the client closes the stream. - StreamingDetectIntentRequest::setInputAudio() — Method in class StreamingDetectIntentRequest
- Optional. The input audio content to be recognized. Must be sent if
query_inputwas set to a streaming input audio config. The complete audio over all streaming messages must not exceed 1 minute. - StreamingDetectIntentResponse — Class in namespace Google\Cloud\Dialogflow\V2
- The top-level message returned from the
StreamingDetectIntentmethod. - StreamingDetectIntentResponse::setResponseId() — Method in class StreamingDetectIntentResponse
- The unique identifier of the response. It can be used to locate a response in the training example set or for reporting issues.
- StreamingDetectIntentResponse::setRecognitionResult() — Method in class StreamingDetectIntentResponse
- The result of speech recognition.
- StreamingDetectIntentResponse::setQueryResult() — Method in class StreamingDetectIntentResponse
- The result of the conversational query or event processing.
- StreamingDetectIntentResponse::setWebhookStatus() — Method in class StreamingDetectIntentResponse
- Specifies the status of the webhook request.
- StreamingRecognitionResult — Class in namespace Google\Cloud\Dialogflow\V2
- Contains a speech recognition result corresponding to a portion of the audio that is currently being processed or an indication that this is the end of the single requested utterance.
- StreamingRecognitionResult::setMessageType() — Method in class StreamingRecognitionResult
- Type of the result message.
- StreamingRecognitionResult::setTranscript() — Method in class StreamingRecognitionResult
- Transcript text representing the words that the user spoke.
- StreamingRecognitionResult::setIsFinal() — Method in class StreamingRecognitionResult
- The default of 0.0 is a sentinel value indicating
confidencewas not set. - StreamingRecognitionResult::setConfidence() — Method in class StreamingRecognitionResult
- The Speech confidence between 0.0 and 1.0 for the current portion of audio.
- StreamingRecognitionResult_MessageType — Class in namespace Google\Cloud\Dialogflow\V2
- Type of the response message.
- TextInput::setText() — Method in class TextInput
- Required. The UTF-8 encoded natural language text to be processed.
- TextInput::setLanguageCode() — Method in class TextInput
- Required. The language of this conversational query. See Language Support for a list of the currently supported language codes. Note that queries in the same session do not necessarily need to specify the same language.
- TrainAgentRequest::setParent() — Method in class TrainAgentRequest
- Required. The project that the agent to train is associated with.
- UpdateContextRequest::setContext() — Method in class UpdateContextRequest
- Required. The context to update.
- UpdateContextRequest::setUpdateMask() — Method in class UpdateContextRequest
- Optional. The mask to control which fields get updated.
- UpdateEntityTypeRequest::setEntityType() — Method in class UpdateEntityTypeRequest
- Required. The entity type to update.
- UpdateEntityTypeRequest::setLanguageCode() — Method in class UpdateEntityTypeRequest
- Optional. The language of entity synonyms defined in
entity_type. If not specified, the agent's default language is used. - UpdateEntityTypeRequest::setUpdateMask() — Method in class UpdateEntityTypeRequest
- Optional. The mask to control which fields get updated.
- UpdateIntentRequest::setIntent() — Method in class UpdateIntentRequest
- Required. The intent to update.
- UpdateIntentRequest::setLanguageCode() — Method in class UpdateIntentRequest
- Optional. The language of training phrases, parameters and rich messages
defined in
intent. If not specified, the agent's default language is used. More than a dozen languages are supported. - UpdateIntentRequest::setUpdateMask() — Method in class UpdateIntentRequest
- Optional. The mask to control which fields get updated.
- UpdateIntentRequest::setIntentView() — Method in class UpdateIntentRequest
- Optional. The resource view to apply to the returned intent.
- UpdateSessionEntityTypeRequest::setSessionEntityType() — Method in class UpdateSessionEntityTypeRequest
- Required. The entity type to update. Format:
projects/<Project ID>/agent/sessions/<Session ID>/entityTypes/<Entity Type Display Name>. - UpdateSessionEntityTypeRequest::setUpdateMask() — Method in class UpdateSessionEntityTypeRequest
- Optional. The mask to control which fields get updated.
- WebhookRequest::setSession() — Method in class WebhookRequest
- The unique identifier of detectIntent request session.
- WebhookRequest::setResponseId() — Method in class WebhookRequest
- The unique identifier of the response. Contains the same value as
[Streaming]DetectIntentResponse.response_id. - WebhookRequest::setQueryResult() — Method in class WebhookRequest
- The result of the conversational query or event processing. Contains the
same value as
[Streaming]DetectIntentResponse.query_result. - WebhookRequest::setOriginalDetectIntentRequest() — Method in class WebhookRequest
- Optional. The contents of the original request that was passed to
[Streaming]DetectIntentcall. - WebhookResponse::setFulfillmentText() — Method in class WebhookResponse
- Optional. The text to be shown on the screen. This value is passed directly
to
QueryResult.fulfillment_text. - WebhookResponse::setFulfillmentMessages() — Method in class WebhookResponse
- Optional. The collection of rich messages to present to the user. This
value is passed directly to
QueryResult.fulfillment_messages. - WebhookResponse::setSource() — Method in class WebhookResponse
- Optional. This value is passed directly to
QueryResult.webhook_source. - WebhookResponse::setPayload() — Method in class WebhookResponse
- Optional. This value is passed directly to
QueryResult.webhook_payload. - WebhookResponse::setOutputContexts() — Method in class WebhookResponse
- Optional. The collection of output contexts. This value is passed directly
to
QueryResult.output_contexts. - WebhookResponse::setFollowupEventInput() — Method in class WebhookResponse
- Optional. Makes the platform immediately invoke another
DetectIntentcall internally with the specified event as input. - Action::setSaveFindings() — Method in class Action
- Save resulting findings in a provided location.
- Action::setPubSub() — Method in class Action
- Publish a notification to a pubsub topic.
- Action::setPublishSummaryToCscc() — Method in class Action
- Publish summary to Cloud Security Command Center (Alpha).
- Action_PublishToPubSub::setTopic() — Method in class Action_PublishToPubSub
- Cloud Pub/Sub topic to send notifications to. The topic must have given publishing access rights to the DLP API service account executing the long running DlpJob sending the notifications.
- Action_SaveFindings::setOutputConfig() — Method in class Action_SaveFindings
- Generated from protobuf field
.google.privacy.dlp.v2.OutputStorageConfig output_config = 1; - AnalyzeDataSourceRiskDetails::setRequestedPrivacyMetric() — Method in class AnalyzeDataSourceRiskDetails
- Privacy metric to compute.
- AnalyzeDataSourceRiskDetails::setRequestedSourceTable() — Method in class AnalyzeDataSourceRiskDetails
- Input dataset to compute metrics over.
- AnalyzeDataSourceRiskDetails::setNumericalStatsResult() — Method in class AnalyzeDataSourceRiskDetails
- Generated from protobuf field
.google.privacy.dlp.v2.AnalyzeDataSourceRiskDetails.NumericalStatsResult numerical_stats_result = 3; - AnalyzeDataSourceRiskDetails::setCategoricalStatsResult() — Method in class AnalyzeDataSourceRiskDetails
- Generated from protobuf field
.google.privacy.dlp.v2.AnalyzeDataSourceRiskDetails.CategoricalStatsResult categorical_stats_result = 4; - AnalyzeDataSourceRiskDetails::setKAnonymityResult() — Method in class AnalyzeDataSourceRiskDetails
- Generated from protobuf field
.google.privacy.dlp.v2.AnalyzeDataSourceRiskDetails.KAnonymityResult k_anonymity_result = 5; - AnalyzeDataSourceRiskDetails::setLDiversityResult() — Method in class AnalyzeDataSourceRiskDetails
- Generated from protobuf field
.google.privacy.dlp.v2.AnalyzeDataSourceRiskDetails.LDiversityResult l_diversity_result = 6; - AnalyzeDataSourceRiskDetails::setKMapEstimationResult() — Method in class AnalyzeDataSourceRiskDetails
- Generated from protobuf field
.google.privacy.dlp.v2.AnalyzeDataSourceRiskDetails.KMapEstimationResult k_map_estimation_result = 7; - AnalyzeDataSourceRiskDetails_CategoricalStatsResult::setValueFrequencyHistogramBuckets() — Method in class AnalyzeDataSourceRiskDetails_CategoricalStatsResult
- Histogram of value frequencies in the column.
- AnalyzeDataSourceRiskDetails_CategoricalStatsResult_CategoricalStatsHistogramBucket::setValueFrequencyLowerBound() — Method in class AnalyzeDataSourceRiskDetails_CategoricalStatsResult_CategoricalStatsHistogramBucket
- Lower bound on the value frequency of the values in this bucket.
- AnalyzeDataSourceRiskDetails_CategoricalStatsResult_CategoricalStatsHistogramBucket::setValueFrequencyUpperBound() — Method in class AnalyzeDataSourceRiskDetails_CategoricalStatsResult_CategoricalStatsHistogramBucket
- Upper bound on the value frequency of the values in this bucket.
- AnalyzeDataSourceRiskDetails_CategoricalStatsResult_CategoricalStatsHistogramBucket::setBucketSize() — Method in class AnalyzeDataSourceRiskDetails_CategoricalStatsResult_CategoricalStatsHistogramBucket
- Total number of values in this bucket.
- AnalyzeDataSourceRiskDetails_CategoricalStatsResult_CategoricalStatsHistogramBucket::setBucketValues() — Method in class AnalyzeDataSourceRiskDetails_CategoricalStatsResult_CategoricalStatsHistogramBucket
- Sample of value frequencies in this bucket. The total number of values returned per bucket is capped at 20.
- AnalyzeDataSourceRiskDetails_CategoricalStatsResult_CategoricalStatsHistogramBucket::setBucketValueCount() — Method in class AnalyzeDataSourceRiskDetails_CategoricalStatsResult_CategoricalStatsHistogramBucket
- Total number of distinct values in this bucket.
- AnalyzeDataSourceRiskDetails_KAnonymityResult::setEquivalenceClassHistogramBuckets() — Method in class AnalyzeDataSourceRiskDetails_KAnonymityResult
- Histogram of k-anonymity equivalence classes.
- AnalyzeDataSourceRiskDetails_KAnonymityResult_KAnonymityEquivalenceClass::setQuasiIdsValues() — Method in class AnalyzeDataSourceRiskDetails_KAnonymityResult_KAnonymityEquivalenceClass
- Set of values defining the equivalence class. One value per quasi-identifier column in the original KAnonymity metric message.
- AnalyzeDataSourceRiskDetails_KAnonymityResult_KAnonymityEquivalenceClass::setEquivalenceClassSize() — Method in class AnalyzeDataSourceRiskDetails_KAnonymityResult_KAnonymityEquivalenceClass
- Size of the equivalence class, for example number of rows with the above set of values.
- AnalyzeDataSourceRiskDetails_KAnonymityResult_KAnonymityHistogramBucket::setEquivalenceClassSizeLowerBound() — Method in class AnalyzeDataSourceRiskDetails_KAnonymityResult_KAnonymityHistogramBucket
- Lower bound on the size of the equivalence classes in this bucket.
- AnalyzeDataSourceRiskDetails_KAnonymityResult_KAnonymityHistogramBucket::setEquivalenceClassSizeUpperBound() — Method in class AnalyzeDataSourceRiskDetails_KAnonymityResult_KAnonymityHistogramBucket
- Upper bound on the size of the equivalence classes in this bucket.
- AnalyzeDataSourceRiskDetails_KAnonymityResult_KAnonymityHistogramBucket::setBucketSize() — Method in class AnalyzeDataSourceRiskDetails_KAnonymityResult_KAnonymityHistogramBucket
- Total number of equivalence classes in this bucket.
- AnalyzeDataSourceRiskDetails_KAnonymityResult_KAnonymityHistogramBucket::setBucketValues() — Method in class AnalyzeDataSourceRiskDetails_KAnonymityResult_KAnonymityHistogramBucket
- Sample of equivalence classes in this bucket. The total number of classes returned per bucket is capped at 20.
- AnalyzeDataSourceRiskDetails_KAnonymityResult_KAnonymityHistogramBucket::setBucketValueCount() — Method in class AnalyzeDataSourceRiskDetails_KAnonymityResult_KAnonymityHistogramBucket
- Total number of distinct equivalence classes in this bucket.
- AnalyzeDataSourceRiskDetails_KMapEstimationResult::setKMapEstimationHistogram() — Method in class AnalyzeDataSourceRiskDetails_KMapEstimationResult
- The intervals [min_anonymity, max_anonymity] do not overlap. If a value doesn't correspond to any such interval, the associated frequency is zero. For example, the following records: {min_anonymity: 1, max_anonymity: 1, frequency: 17} {min_anonymity: 2, max_anonymity: 3, frequency: 42} {min_anonymity: 5, max_anonymity: 10, frequency: 99} mean that there are no record with an estimated anonymity of 4, 5, or larger than 10.
- AnalyzeDataSourceRiskDetails_KMapEstimationResult_KMapEstimationHistogramBucket::setMinAnonymity() — Method in class AnalyzeDataSourceRiskDetails_KMapEstimationResult_KMapEstimationHistogramBucket
- Always positive.
- AnalyzeDataSourceRiskDetails_KMapEstimationResult_KMapEstimationHistogramBucket::setMaxAnonymity() — Method in class AnalyzeDataSourceRiskDetails_KMapEstimationResult_KMapEstimationHistogramBucket
- Always greater than or equal to min_anonymity.
- AnalyzeDataSourceRiskDetails_KMapEstimationResult_KMapEstimationHistogramBucket::setBucketSize() — Method in class AnalyzeDataSourceRiskDetails_KMapEstimationResult_KMapEstimationHistogramBucket
- Number of records within these anonymity bounds.
- AnalyzeDataSourceRiskDetails_KMapEstimationResult_KMapEstimationHistogramBucket::setBucketValues() — Method in class AnalyzeDataSourceRiskDetails_KMapEstimationResult_KMapEstimationHistogramBucket
- Sample of quasi-identifier tuple values in this bucket. The total number of classes returned per bucket is capped at 20.
- AnalyzeDataSourceRiskDetails_KMapEstimationResult_KMapEstimationHistogramBucket::setBucketValueCount() — Method in class AnalyzeDataSourceRiskDetails_KMapEstimationResult_KMapEstimationHistogramBucket
- Total number of distinct quasi-identifier tuple values in this bucket.
- AnalyzeDataSourceRiskDetails_KMapEstimationResult_KMapEstimationQuasiIdValues::setQuasiIdsValues() — Method in class AnalyzeDataSourceRiskDetails_KMapEstimationResult_KMapEstimationQuasiIdValues
- The quasi-identifier values.
- AnalyzeDataSourceRiskDetails_KMapEstimationResult_KMapEstimationQuasiIdValues::setEstimatedAnonymity() — Method in class AnalyzeDataSourceRiskDetails_KMapEstimationResult_KMapEstimationQuasiIdValues
- The estimated anonymity for these quasi-identifier values.
- AnalyzeDataSourceRiskDetails_LDiversityResult::setSensitiveValueFrequencyHistogramBuckets() — Method in class AnalyzeDataSourceRiskDetails_LDiversityResult
- Histogram of l-diversity equivalence class sensitive value frequencies.
- AnalyzeDataSourceRiskDetails_LDiversityResult_LDiversityEquivalenceClass::setQuasiIdsValues() — Method in class AnalyzeDataSourceRiskDetails_LDiversityResult_LDiversityEquivalenceClass
- Quasi-identifier values defining the k-anonymity equivalence class. The order is always the same as the original request.
- AnalyzeDataSourceRiskDetails_LDiversityResult_LDiversityEquivalenceClass::setEquivalenceClassSize() — Method in class AnalyzeDataSourceRiskDetails_LDiversityResult_LDiversityEquivalenceClass
- Size of the k-anonymity equivalence class.
- AnalyzeDataSourceRiskDetails_LDiversityResult_LDiversityEquivalenceClass::setNumDistinctSensitiveValues() — Method in class AnalyzeDataSourceRiskDetails_LDiversityResult_LDiversityEquivalenceClass
- Number of distinct sensitive values in this equivalence class.
- AnalyzeDataSourceRiskDetails_LDiversityResult_LDiversityEquivalenceClass::setTopSensitiveValues() — Method in class AnalyzeDataSourceRiskDetails_LDiversityResult_LDiversityEquivalenceClass
- Estimated frequencies of top sensitive values.
- AnalyzeDataSourceRiskDetails_LDiversityResult_LDiversityHistogramBucket::setSensitiveValueFrequencyLowerBound() — Method in class AnalyzeDataSourceRiskDetails_LDiversityResult_LDiversityHistogramBucket
- Lower bound on the sensitive value frequencies of the equivalence classes in this bucket.
- AnalyzeDataSourceRiskDetails_LDiversityResult_LDiversityHistogramBucket::setSensitiveValueFrequencyUpperBound() — Method in class AnalyzeDataSourceRiskDetails_LDiversityResult_LDiversityHistogramBucket
- Upper bound on the sensitive value frequencies of the equivalence classes in this bucket.
- AnalyzeDataSourceRiskDetails_LDiversityResult_LDiversityHistogramBucket::setBucketSize() — Method in class AnalyzeDataSourceRiskDetails_LDiversityResult_LDiversityHistogramBucket
- Total number of equivalence classes in this bucket.
- AnalyzeDataSourceRiskDetails_LDiversityResult_LDiversityHistogramBucket::setBucketValues() — Method in class AnalyzeDataSourceRiskDetails_LDiversityResult_LDiversityHistogramBucket
- Sample of equivalence classes in this bucket. The total number of classes returned per bucket is capped at 20.
- AnalyzeDataSourceRiskDetails_LDiversityResult_LDiversityHistogramBucket::setBucketValueCount() — Method in class AnalyzeDataSourceRiskDetails_LDiversityResult_LDiversityHistogramBucket
- Total number of distinct equivalence classes in this bucket.
- AnalyzeDataSourceRiskDetails_NumericalStatsResult::setMinValue() — Method in class AnalyzeDataSourceRiskDetails_NumericalStatsResult
- Minimum value appearing in the column.
- AnalyzeDataSourceRiskDetails_NumericalStatsResult::setMaxValue() — Method in class AnalyzeDataSourceRiskDetails_NumericalStatsResult
- Maximum value appearing in the column.
- AnalyzeDataSourceRiskDetails_NumericalStatsResult::setQuantileValues() — Method in class AnalyzeDataSourceRiskDetails_NumericalStatsResult
- List of 99 values that partition the set of field values into 100 equal sized buckets.
- BigQueryKey::setTableReference() — Method in class BigQueryKey
- Complete BigQuery table reference.
- BigQueryKey::setRowNumber() — Method in class BigQueryKey
- Absolute number of the row from the beginning of the table at the time of scanning.
- BigQueryOptions::setTableReference() — Method in class BigQueryOptions
- Complete BigQuery table reference.
- BigQueryOptions::setIdentifyingFields() — Method in class BigQueryOptions
- References to fields uniquely identifying rows within the table.
- BigQueryOptions::setRowsLimit() — Method in class BigQueryOptions
- Max number of rows to scan. If the table has more rows than this value, the rest of the rows are omitted. If not set, or if set to 0, all rows will be scanned. Cannot be used in conjunction with TimespanConfig.
- BigQueryOptions::setSampleMethod() — Method in class BigQueryOptions
- Generated from protobuf field
.google.privacy.dlp.v2.BigQueryOptions.SampleMethod sample_method = 4; - BigQueryTable::setProjectId() — Method in class BigQueryTable
- The Google Cloud Platform project ID of the project containing the table.
- BigQueryTable::setDatasetId() — Method in class BigQueryTable
- Dataset ID of the table.
- BigQueryTable::setTableId() — Method in class BigQueryTable
- Name of the table.
- BoundingBox::setTop() — Method in class BoundingBox
- Top coordinate of the bounding box. (0,0) is upper left.
- BoundingBox::setLeft() — Method in class BoundingBox
- Left coordinate of the bounding box. (0,0) is upper left.
- BoundingBox::setWidth() — Method in class BoundingBox
- Width of the bounding box in pixels.
- BoundingBox::setHeight() — Method in class BoundingBox
- Height of the bounding box in pixels.
- BucketingConfig::setBuckets() — Method in class BucketingConfig
- Set of buckets. Ranges must be non-overlapping.
- BucketingConfig_Bucket::setMin() — Method in class BucketingConfig_Bucket
- Lower bound of the range, inclusive. Type should be the same as max if used.
- BucketingConfig_Bucket::setMax() — Method in class BucketingConfig_Bucket
- Upper bound of the range, exclusive; type must match min.
- BucketingConfig_Bucket::setReplacementValue() — Method in class BucketingConfig_Bucket
- Replacement value for this bucket. If not provided the default behavior will be to hyphenate the min-max range.
- ByteContentItem::setType() — Method in class ByteContentItem
- The type of data stored in the bytes string. Default will be TEXT_UTF8.
- ByteContentItem::setData() — Method in class ByteContentItem
- Content data to inspect or redact.
- CancelDlpJobRequest::setName() — Method in class CancelDlpJobRequest
- The name of the DlpJob resource to be cancelled.
- CharacterMaskConfig::setMaskingCharacter() — Method in class CharacterMaskConfig
- Character to mask the sensitive values—for example, "" for an alphabetic string such as name, or "0" for a numeric string such as ZIP code or credit card number. String must have length 1. If not supplied, we will default to "" for strings, 0 for digits.
- CharacterMaskConfig::setNumberToMask() — Method in class CharacterMaskConfig
- Number of characters to mask. If not set, all matching chars will be masked. Skipped characters do not count towards this tally.
- CharacterMaskConfig::setReverseOrder() — Method in class CharacterMaskConfig
- Mask characters in reverse order. For example, if
masking_characteris '0', number_to_mask is 14, andreverse_orderis false, then 1234-5678-9012-3456 -> 00000000000000-3456 Ifmasking_characteris '*',number_to_maskis 3, andreverse_orderis true, then 12345 -> 12*** - CharacterMaskConfig::setCharactersToIgnore() — Method in class CharacterMaskConfig
- When masking a string, items in this list will be skipped when replacing.
- CharsToIgnore::setCharactersToSkip() — Method in class CharsToIgnore
- Generated from protobuf field
string characters_to_skip = 1; - CharsToIgnore::setCommonCharactersToIgnore() — Method in class CharsToIgnore
- Generated from protobuf field
.google.privacy.dlp.v2.CharsToIgnore.CommonCharsToIgnore common_characters_to_ignore = 2; - CloudStorageOptions::setFileSet() — Method in class CloudStorageOptions
- Generated from protobuf field
.google.privacy.dlp.v2.CloudStorageOptions.FileSet file_set = 1; - CloudStorageOptions::setBytesLimitPerFile() — Method in class CloudStorageOptions
- Max number of bytes to scan from a file. If a scanned file's size is bigger than this value then the rest of the bytes are omitted.
- CloudStorageOptions::setFileTypes() — Method in class CloudStorageOptions
- List of file type groups to include in the scan.
- CloudStorageOptions::setSampleMethod() — Method in class CloudStorageOptions
- Generated from protobuf field
.google.privacy.dlp.v2.CloudStorageOptions.SampleMethod sample_method = 6; - CloudStorageOptions::setFilesLimitPercent() — Method in class CloudStorageOptions
- Limits the number of files to scan to this percentage of the input FileSet.
- CloudStorageOptions_FileSet::setUrl() — Method in class CloudStorageOptions_FileSet
- The url, in the format
gs://<bucket>/<path>. Trailing wildcard in the path is allowed. - CloudStoragePath::setPath() — Method in class CloudStoragePath
- A url representing a file or path (no wildcards) in Cloud Storage.
- Color::setRed() — Method in class Color
- The amount of red in the color as a value in the interval [0, 1].
- Color::setGreen() — Method in class Color
- The amount of green in the color as a value in the interval [0, 1].
- Color::setBlue() — Method in class Color
- The amount of blue in the color as a value in the interval [0, 1].
- ContentItem::setValue() — Method in class ContentItem
- String data to inspect or redact.
- ContentItem::setTable() — Method in class ContentItem
- Structured content for inspection.
- ContentItem::setByteItem() — Method in class ContentItem
- Content data to inspect or redact. Replaces
typeanddata. - ContentLocation::setContainerName() — Method in class ContentLocation
- Name of the container where the finding is located.
- ContentLocation::setRecordLocation() — Method in class ContentLocation
- Location within a row or record of a database table.
- ContentLocation::setImageLocation() — Method in class ContentLocation
- Location within an image's pixels.
- ContentLocation::setDocumentLocation() — Method in class ContentLocation
- Location data for document files.
- ContentLocation::setContainerTimestamp() — Method in class ContentLocation
- Findings container modification timestamp, if applicable.
- ContentLocation::setContainerVersion() — Method in class ContentLocation
- Findings container version, if available ("generation" for Google Cloud Storage).
- CreateDeidentifyTemplateRequest::setParent() — Method in class CreateDeidentifyTemplateRequest
- The parent resource name, for example projects/my-project-id or organizations/my-org-id.
- CreateDeidentifyTemplateRequest::setDeidentifyTemplate() — Method in class CreateDeidentifyTemplateRequest
- The DeidentifyTemplate to create.
- CreateDeidentifyTemplateRequest::setTemplateId() — Method in class CreateDeidentifyTemplateRequest
- The template id can contain uppercase and lowercase letters,
numbers, and hyphens; that is, it must match the regular
expression:
[a-zA-Z\\d-]+. The maximum length is 100 characters. Can be empty to allow the system to generate one. - CreateDlpJobRequest::setParent() — Method in class CreateDlpJobRequest
- The parent resource name, for example projects/my-project-id.
- CreateDlpJobRequest::setInspectJob() — Method in class CreateDlpJobRequest
- Generated from protobuf field
.google.privacy.dlp.v2.InspectJobConfig inspect_job = 2; - CreateDlpJobRequest::setRiskJob() — Method in class CreateDlpJobRequest
- Generated from protobuf field
.google.privacy.dlp.v2.RiskAnalysisJobConfig risk_job = 3; - CreateDlpJobRequest::setJobId() — Method in class CreateDlpJobRequest
- The job id can contain uppercase and lowercase letters,
numbers, and hyphens; that is, it must match the regular
expression:
[a-zA-Z\\d-]+. The maximum length is 100 characters. Can be empty to allow the system to generate one. - CreateInspectTemplateRequest::setParent() — Method in class CreateInspectTemplateRequest
- The parent resource name, for example projects/my-project-id or organizations/my-org-id.
- CreateInspectTemplateRequest::setInspectTemplate() — Method in class CreateInspectTemplateRequest
- The InspectTemplate to create.
- CreateInspectTemplateRequest::setTemplateId() — Method in class CreateInspectTemplateRequest
- The template id can contain uppercase and lowercase letters,
numbers, and hyphens; that is, it must match the regular
expression:
[a-zA-Z\\d-]+. The maximum length is 100 characters. Can be empty to allow the system to generate one. - CreateJobTriggerRequest::setParent() — Method in class CreateJobTriggerRequest
- The parent resource name, for example projects/my-project-id.
- CreateJobTriggerRequest::setJobTrigger() — Method in class CreateJobTriggerRequest
- The JobTrigger to create.
- CreateJobTriggerRequest::setTriggerId() — Method in class CreateJobTriggerRequest
- The trigger id can contain uppercase and lowercase letters,
numbers, and hyphens; that is, it must match the regular
expression:
[a-zA-Z\\d-]+. The maximum length is 100 characters. Can be empty to allow the system to generate one. - CryptoHashConfig::setCryptoKey() — Method in class CryptoHashConfig
- The key used by the hash function.
- $CryptoKey#source — Property in class CryptoKey
- CryptoKey::setTransient() — Method in class CryptoKey
- Generated from protobuf field
.google.privacy.dlp.v2.TransientCryptoKey transient = 1; - CryptoKey::setUnwrapped() — Method in class CryptoKey
- Generated from protobuf field
.google.privacy.dlp.v2.UnwrappedCryptoKey unwrapped = 2; - CryptoKey::setKmsWrapped() — Method in class CryptoKey
- Generated from protobuf field
.google.privacy.dlp.v2.KmsWrappedCryptoKey kms_wrapped = 3; - CryptoReplaceFfxFpeConfig::setCryptoKey() — Method in class CryptoReplaceFfxFpeConfig
- The key used by the encryption algorithm. [required]
- CryptoReplaceFfxFpeConfig::setContext() — Method in class CryptoReplaceFfxFpeConfig
- The 'tweak', a context may be used for higher security since the same identifier in two different contexts won't be given the same surrogate. If the context is not set, a default tweak will be used.
- CryptoReplaceFfxFpeConfig::setCommonAlphabet() — Method in class CryptoReplaceFfxFpeConfig
- Generated from protobuf field
.google.privacy.dlp.v2.CryptoReplaceFfxFpeConfig.FfxCommonNativeAlphabet common_alphabet = 4; - CryptoReplaceFfxFpeConfig::setCustomAlphabet() — Method in class CryptoReplaceFfxFpeConfig
- This is supported by mapping these to the alphanumeric characters that the FFX mode natively supports. This happens before/after encryption/decryption.
- CryptoReplaceFfxFpeConfig::setRadix() — Method in class CryptoReplaceFfxFpeConfig
- The native way to select the alphabet. Must be in the range [2, 62].
- CryptoReplaceFfxFpeConfig::setSurrogateInfoType() — Method in class CryptoReplaceFfxFpeConfig
- The custom infoType to annotate the surrogate with.
- CustomInfoType::setInfoType() — Method in class CustomInfoType
- Info type configuration. All custom info types must have configurations that do not conflict with built-in info types or other custom info types.
- CustomInfoType::setLikelihood() — Method in class CustomInfoType
- Likelihood to return for this custom info type. This base value can be
altered by a detection rule if the finding meets the criteria specified by
the rule. Defaults to
VERY_LIKELYif not specified. - CustomInfoType::setDictionary() — Method in class CustomInfoType
- Dictionary-based custom info type.
- CustomInfoType::setRegex() — Method in class CustomInfoType
- Regex-based custom info type.
- CustomInfoType::setSurrogateType() — Method in class CustomInfoType
- Surrogate info type.
- CustomInfoType::setDetectionRules() — Method in class CustomInfoType
- Set of detection rules to apply to all findings of this custom info type.
- CustomInfoType_DetectionRule::setHotwordRule() — Method in class CustomInfoType_DetectionRule
- Hotword-based detection rule.
- CustomInfoType_DetectionRule_HotwordRule::setHotwordRegex() — Method in class CustomInfoType_DetectionRule_HotwordRule
- Regex pattern defining what qualifies as a hotword.
- CustomInfoType_DetectionRule_HotwordRule::setProximity() — Method in class CustomInfoType_DetectionRule_HotwordRule
- Proximity of the finding within which the entire hotword must reside.
- CustomInfoType_DetectionRule_HotwordRule::setLikelihoodAdjustment() — Method in class CustomInfoType_DetectionRule_HotwordRule
- Likelihood adjustment to apply to all matching findings.
- CustomInfoType_DetectionRule_LikelihoodAdjustment::setFixedLikelihood() — Method in class CustomInfoType_DetectionRule_LikelihoodAdjustment
- Set the likelihood of a finding to a fixed value.
- CustomInfoType_DetectionRule_LikelihoodAdjustment::setRelativeLikelihood() — Method in class CustomInfoType_DetectionRule_LikelihoodAdjustment
- Increase or decrease the likelihood by the specified number of
levels. For example, if a finding would be
POSSIBLEwithout the detection rule andrelative_likelihoodis 1, then it is upgraded toLIKELY, while a value of -1 would downgrade it toUNLIKELY. - CustomInfoType_DetectionRule_Proximity::setWindowBefore() — Method in class CustomInfoType_DetectionRule_Proximity
- Number of characters before the finding to consider.
- CustomInfoType_DetectionRule_Proximity::setWindowAfter() — Method in class CustomInfoType_DetectionRule_Proximity
- Number of characters after the finding to consider.
- $CustomInfoType_Dictionary#source — Property in class CustomInfoType_Dictionary
- CustomInfoType_Dictionary::setWordList() — Method in class CustomInfoType_Dictionary
- List of words or phrases to search for.
- CustomInfoType_Dictionary::setCloudStoragePath() — Method in class CustomInfoType_Dictionary
- Newline-delimited file of words in Cloud Storage. Only a single file is accepted.
- CustomInfoType_Dictionary_WordList::setWords() — Method in class CustomInfoType_Dictionary_WordList
- Words or phrases defining the dictionary. The dictionary must contain at least one phrase and every phrase must contain at least 2 characters that are letters or digits. [required]
- CustomInfoType_Regex::setPattern() — Method in class CustomInfoType_Regex
- Pattern defining the regular expression.
- DatastoreKey::setEntityKey() — Method in class DatastoreKey
- Datastore entity key.
- DatastoreOptions::setPartitionId() — Method in class DatastoreOptions
- A partition ID identifies a grouping of entities. The grouping is always by project and namespace, however the namespace ID may be empty.
- DatastoreOptions::setKind() — Method in class DatastoreOptions
- The kind to process.
- DateShiftConfig::setUpperBoundDays() — Method in class DateShiftConfig
- Range of shift in days. Actual shift will be selected at random within this range (inclusive ends). Negative means shift to earlier in time. Must not be more than 365250 days (1000 years) each direction.
- DateShiftConfig::setLowerBoundDays() — Method in class DateShiftConfig
- For example, -5 means shift date to at most 5 days back in the past.
- DateShiftConfig::setContext() — Method in class DateShiftConfig
- Points to the field that contains the context, for example, an entity id.
- DateShiftConfig::setCryptoKey() — Method in class DateShiftConfig
- Causes the shift to be computed based on this key and the context. This results in the same shift for the same context and crypto_key.
- DateTime::setDate() — Method in class DateTime
- One or more of the following must be set. All fields are optional, but when set must be valid date or time values.
- DateTime::setDayOfWeek() — Method in class DateTime
- Generated from protobuf field
.google.type.DayOfWeek day_of_week = 2; - DateTime::setTime() — Method in class DateTime
- Generated from protobuf field
.google.type.TimeOfDay time = 3; - DateTime::setTimeZone() — Method in class DateTime
- Generated from protobuf field
.google.privacy.dlp.v2.DateTime.TimeZone time_zone = 4; - DateTime_TimeZone::setOffsetMinutes() — Method in class DateTime_TimeZone
- Set only if the offset can be determined. Positive for time ahead of UTC.
- DeidentifyConfig::setInfoTypeTransformations() — Method in class DeidentifyConfig
- Treat the dataset as free-form text and apply the same free text transformation everywhere.
- DeidentifyConfig::setRecordTransformations() — Method in class DeidentifyConfig
- Treat the dataset as structured. Transformations can be applied to specific locations within structured datasets, such as transforming a column within a table.
- DeidentifyContentRequest::setParent() — Method in class DeidentifyContentRequest
- The parent resource name, for example projects/my-project-id.
- DeidentifyContentRequest::setDeidentifyConfig() — Method in class DeidentifyContentRequest
- Configuration for the de-identification of the content item.
- DeidentifyContentRequest::setInspectConfig() — Method in class DeidentifyContentRequest
- Configuration for the inspector.
- DeidentifyContentRequest::setItem() — Method in class DeidentifyContentRequest
- The item to de-identify. Will be treated as text.
- DeidentifyContentRequest::setInspectTemplateName() — Method in class DeidentifyContentRequest
- Optional template to use. Any configuration directly specified in inspect_config will override those set in the template. Singular fields that are set in this request will replace their corresponding fields in the template. Repeated fields are appended. Singular sub-messages and groups are recursively merged.
- DeidentifyContentRequest::setDeidentifyTemplateName() — Method in class DeidentifyContentRequest
- Optional template to use. Any configuration directly specified in deidentify_config will override those set in the template. Singular fields that are set in this request will replace their corresponding fields in the template. Repeated fields are appended. Singular sub-messages and groups are recursively merged.
- DeidentifyContentResponse::setItem() — Method in class DeidentifyContentResponse
- The de-identified item.
- DeidentifyContentResponse::setOverview() — Method in class DeidentifyContentResponse
- An overview of the changes that were made on the
item. - DeidentifyTemplate::setName() — Method in class DeidentifyTemplate
- The template name. Output only.
- DeidentifyTemplate::setDisplayName() — Method in class DeidentifyTemplate
- Display name (max 256 chars).
- DeidentifyTemplate::setDescription() — Method in class DeidentifyTemplate
- Short description (max 256 chars).
- DeidentifyTemplate::setCreateTime() — Method in class DeidentifyTemplate
- The creation timestamp of a inspectTemplate, output only field.
- DeidentifyTemplate::setUpdateTime() — Method in class DeidentifyTemplate
- The last update timestamp of a inspectTemplate, output only field.
- DeidentifyTemplate::setDeidentifyConfig() — Method in class DeidentifyTemplate
- ///////////// // The core content of the template // ///////////////
- DeleteDeidentifyTemplateRequest::setName() — Method in class DeleteDeidentifyTemplateRequest
- Resource name of the organization and deidentify template to be deleted,
for example
organizations/433245324/deidentifyTemplates/432452342or projects/project-id/deidentifyTemplates/432452342. - DeleteDlpJobRequest::setName() — Method in class DeleteDlpJobRequest
- The name of the DlpJob resource to be deleted.
- DeleteInspectTemplateRequest::setName() — Method in class DeleteInspectTemplateRequest
- Resource name of the organization and inspectTemplate to be deleted, for
example
organizations/433245324/inspectTemplates/432452342or projects/project-id/inspectTemplates/432452342. - DeleteJobTriggerRequest::setName() — Method in class DeleteJobTriggerRequest
- Resource name of the project and the triggeredJob, for example
projects/dlp-test-project/jobTriggers/53234423. - DlpJob::setName() — Method in class DlpJob
- The server-assigned name.
- DlpJob::setType() — Method in class DlpJob
- The type of job.
- DlpJob::setState() — Method in class DlpJob
- State of a job.
- DlpJob::setRiskDetails() — Method in class DlpJob
- Results from analyzing risk of a data source.
- DlpJob::setInspectDetails() — Method in class DlpJob
- Results from inspecting a data source.
- DlpJob::setCreateTime() — Method in class DlpJob
- Time when the job was created.
- DlpJob::setStartTime() — Method in class DlpJob
- Time when the job started.
- DlpJob::setEndTime() — Method in class DlpJob
- Time when the job finished.
- DlpJob::setJobTriggerName() — Method in class DlpJob
- If created by a job trigger, the resource name of the trigger that instantiated the job.
- DlpJob::setErrors() — Method in class DlpJob
- A stream of errors encountered running the job.
- DocumentLocation::setFileOffset() — Method in class DocumentLocation
- Offset of the line, from the beginning of the file, where the finding is located.
- EntityId::setField() — Method in class EntityId
- Composite key indicating which field contains the entity identifier.
- Error::setDetails() — Method in class Error
- Generated from protobuf field
.google.rpc.Status details = 1; - Error::setTimestamps() — Method in class Error
- The times the error occurred.
- FieldId::setName() — Method in class FieldId
- Name describing the field.
- FieldTransformation::setFields() — Method in class FieldTransformation
- Input field(s) to apply the transformation to. [required]
- FieldTransformation::setCondition() — Method in class FieldTransformation
- Only apply the transformation if the condition evaluates to true for the
given
RecordCondition. The conditions are allowed to reference fields that are not used in the actual transformation. [optional] Example Use Cases: - Apply a different bucket transformation to an age column if the zip code column for the same record is within a specific range. - FieldTransformation::setPrimitiveTransformation() — Method in class FieldTransformation
- Apply the transformation to the entire field.
- FieldTransformation::setInfoTypeTransformations() — Method in class FieldTransformation
- Treat the contents of the field as free text, and selectively
transform content that matches an
InfoType. - Finding::setQuote() — Method in class Finding
- The content that was found. Even if the content is not textual, it may be converted to a textual representation here.
- Finding::setInfoType() — Method in class Finding
- The type of content that might have been found.
- Finding::setLikelihood() — Method in class Finding
- Estimate of how likely it is that the
info_typeis correct. - Finding::setLocation() — Method in class Finding
- Where the content was found.
- Finding::setCreateTime() — Method in class Finding
- Timestamp when finding was detected.
- Finding::setQuoteInfo() — Method in class Finding
- Contains data parsed from quotes. Only populated if include_quote was set to true and a supported infoType was requested. Currently supported infoTypes: DATE, DATE_OF_BIRTH and TIME.
- FixedSizeBucketingConfig::setLowerBound() — Method in class FixedSizeBucketingConfig
- Lower bound value of buckets. All values less than
lower_boundare grouped together into a single bucket; for example iflower_bound= 10, then all values less than 10 are replaced with the value “-10”. [Required]. - FixedSizeBucketingConfig::setUpperBound() — Method in class FixedSizeBucketingConfig
- Upper bound value of buckets. All values greater than upper_bound are
grouped together into a single bucket; for example if
upper_bound= 89, then all values greater than 89 are replaced with the value “89+”. - FixedSizeBucketingConfig::setBucketSize() — Method in class FixedSizeBucketingConfig
- Size of each bucket (except for minimum and maximum buckets). So if
lower_bound= 10,upper_bound= 89, andbucket_size= 10, then the following buckets would be used: -10, 10-20, 20-30, 30-40, 40-50, 50-60, 60-70, 70-80, 80-89, 89+. Precision up to 2 decimals works. [Required]. - GetDeidentifyTemplateRequest::setName() — Method in class GetDeidentifyTemplateRequest
- Resource name of the organization and deidentify template to be read, for
example
organizations/433245324/deidentifyTemplates/432452342or projects/project-id/deidentifyTemplates/432452342. - GetDlpJobRequest::setName() — Method in class GetDlpJobRequest
- The name of the DlpJob resource.
- GetInspectTemplateRequest::setName() — Method in class GetInspectTemplateRequest
- Resource name of the organization and inspectTemplate to be read, for
example
organizations/433245324/inspectTemplates/432452342or projects/project-id/inspectTemplates/432452342. - GetJobTriggerRequest::setName() — Method in class GetJobTriggerRequest
- Resource name of the project and the triggeredJob, for example
projects/dlp-test-project/jobTriggers/53234423. - ImageLocation::setBoundingBoxes() — Method in class ImageLocation
- Bounding boxes locating the pixels within the image containing the finding.
- InfoType::setName() — Method in class InfoType
- Name of the information type.
- InfoTypeDescription::setName() — Method in class InfoTypeDescription
- Internal name of the infoType.
- InfoTypeDescription::setDisplayName() — Method in class InfoTypeDescription
- Human readable form of the infoType name.
- InfoTypeDescription::setSupportedBy() — Method in class InfoTypeDescription
- Which parts of the API supports this InfoType.
- InfoTypeStats::setInfoType() — Method in class InfoTypeStats
- The type of finding this stat is for.
- InfoTypeStats::setCount() — Method in class InfoTypeStats
- Number of findings for this infoType.
- InfoTypeTransformations::setTransformations() — Method in class InfoTypeTransformations
- Transformation for each infoType. Cannot specify more than one for a given infoType. [required]
- InfoTypeTransformations_InfoTypeTransformation::setInfoTypes() — Method in class InfoTypeTransformations_InfoTypeTransformation
- InfoTypes to apply the transformation to. Empty list will match all available infoTypes for this transformation.
- InfoTypeTransformations_InfoTypeTransformation::setPrimitiveTransformation() — Method in class InfoTypeTransformations_InfoTypeTransformation
- Primitive transformation to apply to the infoType. [required]
- InspectConfig::setInfoTypes() — Method in class InspectConfig
- Restricts what info_types to look for. The values must correspond to InfoType values returned by ListInfoTypes or found in documentation.
- InspectConfig::setMinLikelihood() — Method in class InspectConfig
- Only returns findings equal or above this threshold. The default is POSSIBLE.
- InspectConfig::setLimits() — Method in class InspectConfig
- Generated from protobuf field
.google.privacy.dlp.v2.InspectConfig.FindingLimits limits = 3; - InspectConfig::setIncludeQuote() — Method in class InspectConfig
- When true, a contextual quote from the data that triggered a finding is included in the response; see Finding.quote.
- InspectConfig::setExcludeInfoTypes() — Method in class InspectConfig
- When true, excludes type information of the findings.
- InspectConfig::setCustomInfoTypes() — Method in class InspectConfig
- Custom infoTypes provided by the user.
- InspectConfig::setContentOptions() — Method in class InspectConfig
- List of options defining data content to scan.
- InspectConfig_FindingLimits::setMaxFindingsPerItem() — Method in class InspectConfig_FindingLimits
- Max number of findings that will be returned for each item scanned.
- InspectConfig_FindingLimits::setMaxFindingsPerRequest() — Method in class InspectConfig_FindingLimits
- Max number of findings that will be returned per request/job.
- InspectConfig_FindingLimits::setMaxFindingsPerInfoType() — Method in class InspectConfig_FindingLimits
- Configuration of findings limit given for specified infoTypes.
- InspectConfig_FindingLimits_InfoTypeLimit::setInfoType() — Method in class InspectConfig_FindingLimits_InfoTypeLimit
- Type of information the findings limit applies to. Only one limit per info_type should be provided. If InfoTypeLimit does not have an info_type, the DLP API applies the limit against all info_types that are found but not specified in another InfoTypeLimit.
- InspectConfig_FindingLimits_InfoTypeLimit::setMaxFindings() — Method in class InspectConfig_FindingLimits_InfoTypeLimit
- Max findings limit for the given infoType.
- InspectContentRequest::setParent() — Method in class InspectContentRequest
- The parent resource name, for example projects/my-project-id.
- InspectContentRequest::setInspectConfig() — Method in class InspectContentRequest
- Configuration for the inspector. What specified here will override the template referenced by the inspect_template_name argument.
- InspectContentRequest::setItem() — Method in class InspectContentRequest
- The item to inspect.
- InspectContentRequest::setInspectTemplateName() — Method in class InspectContentRequest
- Optional template to use. Any configuration directly specified in inspect_config will override those set in the template. Singular fields that are set in this request will replace their corresponding fields in the template. Repeated fields are appended. Singular sub-messages and groups are recursively merged.
- InspectContentResponse::setResult() — Method in class InspectContentResponse
- The findings.
- InspectDataSourceDetails::setRequestedOptions() — Method in class InspectDataSourceDetails
- The configuration used for this job.
- InspectDataSourceDetails::setResult() — Method in class InspectDataSourceDetails
- A summary of the outcome of this inspect job.
- InspectDataSourceDetails_RequestedOptions::setSnapshotInspectTemplate() — Method in class InspectDataSourceDetails_RequestedOptions
- If run with an InspectTemplate, a snapshot of its state at the time of this run.
- InspectDataSourceDetails_RequestedOptions::setJobConfig() — Method in class InspectDataSourceDetails_RequestedOptions
- Generated from protobuf field
.google.privacy.dlp.v2.InspectJobConfig job_config = 3; - InspectDataSourceDetails_Result::setProcessedBytes() — Method in class InspectDataSourceDetails_Result
- Total size in bytes that were processed.
- InspectDataSourceDetails_Result::setTotalEstimatedBytes() — Method in class InspectDataSourceDetails_Result
- Estimate of the number of bytes to process.
- InspectDataSourceDetails_Result::setInfoTypeStats() — Method in class InspectDataSourceDetails_Result
- Statistics of how many instances of each info type were found during inspect job.
- InspectJobConfig::setStorageConfig() — Method in class InspectJobConfig
- The data to scan.
- InspectJobConfig::setInspectConfig() — Method in class InspectJobConfig
- How and what to scan for.
- InspectJobConfig::setInspectTemplateName() — Method in class InspectJobConfig
- If provided, will be used as the default for all values in InspectConfig.
- InspectJobConfig::setActions() — Method in class InspectJobConfig
- Actions to execute at the completion of the job. Are executed in the order provided.
- InspectResult::setFindings() — Method in class InspectResult
- List of findings for an item.
- InspectResult::setFindingsTruncated() — Method in class InspectResult
- If true, then this item might have more findings than were returned, and the findings returned are an arbitrary subset of all findings.
- InspectTemplate::setName() — Method in class InspectTemplate
- The template name. Output only.
- InspectTemplate::setDisplayName() — Method in class InspectTemplate
- Display name (max 256 chars).
- InspectTemplate::setDescription() — Method in class InspectTemplate
- Short description (max 256 chars).
- InspectTemplate::setCreateTime() — Method in class InspectTemplate
- The creation timestamp of a inspectTemplate, output only field.
- InspectTemplate::setUpdateTime() — Method in class InspectTemplate
- The last update timestamp of a inspectTemplate, output only field.
- InspectTemplate::setInspectConfig() — Method in class InspectTemplate
- The core content of the template. Configuration of the scanning process.
- JobTrigger::setName() — Method in class JobTrigger
- Unique resource name for the triggeredJob, assigned by the service when the
triggeredJob is created, for example
projects/dlp-test-project/triggeredJobs/53234423. - JobTrigger::setDisplayName() — Method in class JobTrigger
- Display name (max 100 chars)
- JobTrigger::setDescription() — Method in class JobTrigger
- User provided description (max 256 chars)
- JobTrigger::setInspectJob() — Method in class JobTrigger
- Generated from protobuf field
.google.privacy.dlp.v2.InspectJobConfig inspect_job = 4; - JobTrigger::setTriggers() — Method in class JobTrigger
- A list of triggers which will be OR'ed together. Only one in the list needs to trigger for a job to be started. The list may contain only a single Schedule trigger and must have at least one object.
- JobTrigger::setErrors() — Method in class JobTrigger
- A stream of errors encountered when the trigger was activated. Repeated errors may result in the JobTrigger automaticaly being paused.
- JobTrigger::setCreateTime() — Method in class JobTrigger
- The creation timestamp of a triggeredJob, output only field.
- JobTrigger::setUpdateTime() — Method in class JobTrigger
- The last update timestamp of a triggeredJob, output only field.
- JobTrigger::setLastRunTime() — Method in class JobTrigger
- The timestamp of the last time this trigger executed, output only field.
- JobTrigger::setStatus() — Method in class JobTrigger
- A status for this trigger. [required]
- JobTrigger_Trigger::setSchedule() — Method in class JobTrigger_Trigger
- Create a job on a repeating basis based on the elapse of time.
- Key::setPartitionId() — Method in class Key
- Entities are partitioned into subsets, currently identified by a project ID and namespace ID.
- Key::setPath() — Method in class Key
- The entity path.
- Key_PathElement::setKind() — Method in class Key_PathElement
- The kind of the entity.
- Key_PathElement::setId() — Method in class Key_PathElement
- The auto-allocated ID of the entity.
- Key_PathElement::setName() — Method in class Key_PathElement
- The name of the entity.
- KindExpression::setName() — Method in class KindExpression
- The name of the kind.
- KmsWrappedCryptoKey::setWrappedKey() — Method in class KmsWrappedCryptoKey
- The wrapped data crypto key. [required]
- KmsWrappedCryptoKey::setCryptoKeyName() — Method in class KmsWrappedCryptoKey
- The resource name of the KMS CryptoKey to use for unwrapping. [required]
- ListDeidentifyTemplatesRequest::setParent() — Method in class ListDeidentifyTemplatesRequest
- The parent resource name, for example projects/my-project-id or organizations/my-org-id.
- ListDeidentifyTemplatesRequest::setPageToken() — Method in class ListDeidentifyTemplatesRequest
- Optional page token to continue retrieval. Comes from previous call
to
ListDeidentifyTemplates. - ListDeidentifyTemplatesRequest::setPageSize() — Method in class ListDeidentifyTemplatesRequest
- Optional size of the page, can be limited by server. If zero server returns a page of max size 100.
- ListDeidentifyTemplatesResponse::setDeidentifyTemplates() — Method in class ListDeidentifyTemplatesResponse
- List of deidentify templates, up to page_size in ListDeidentifyTemplatesRequest.
- ListDeidentifyTemplatesResponse::setNextPageToken() — Method in class ListDeidentifyTemplatesResponse
- If the next page is available then the next page token to be used in following ListDeidentifyTemplates request.
- ListDlpJobsRequest::setParent() — Method in class ListDlpJobsRequest
- The parent resource name, for example projects/my-project-id.
- ListDlpJobsRequest::setFilter() — Method in class ListDlpJobsRequest
- Optional. Allows filtering.
- ListDlpJobsRequest::setPageSize() — Method in class ListDlpJobsRequest
- The standard list page size.
- ListDlpJobsRequest::setPageToken() — Method in class ListDlpJobsRequest
- The standard list page token.
- ListDlpJobsRequest::setType() — Method in class ListDlpJobsRequest
- The type of job. Defaults to
DlpJobType.INSPECT - ListDlpJobsResponse::setJobs() — Method in class ListDlpJobsResponse
- A list of DlpJobs that matches the specified filter in the request.
- ListDlpJobsResponse::setNextPageToken() — Method in class ListDlpJobsResponse
- The standard List next-page token.
- ListInfoTypesRequest::setLanguageCode() — Method in class ListInfoTypesRequest
- Optional BCP-47 language code for localized infoType friendly names. If omitted, or if localized strings are not available, en-US strings will be returned.
- ListInfoTypesRequest::setFilter() — Method in class ListInfoTypesRequest
- Optional filter to only return infoTypes supported by certain parts of the API. Defaults to supported_by=INSPECT.
- ListInfoTypesResponse::setInfoTypes() — Method in class ListInfoTypesResponse
- Set of sensitive infoTypes.
- ListInspectTemplatesRequest::setParent() — Method in class ListInspectTemplatesRequest
- The parent resource name, for example projects/my-project-id or organizations/my-org-id.
- ListInspectTemplatesRequest::setPageToken() — Method in class ListInspectTemplatesRequest
- Optional page token to continue retrieval. Comes from previous call
to
ListInspectTemplates. - ListInspectTemplatesRequest::setPageSize() — Method in class ListInspectTemplatesRequest
- Optional size of the page, can be limited by server. If zero server returns a page of max size 100.
- ListInspectTemplatesResponse::setInspectTemplates() — Method in class ListInspectTemplatesResponse
- List of inspectTemplates, up to page_size in ListInspectTemplatesRequest.
- ListInspectTemplatesResponse::setNextPageToken() — Method in class ListInspectTemplatesResponse
- If the next page is available then the next page token to be used in following ListInspectTemplates request.
- ListJobTriggersRequest::setParent() — Method in class ListJobTriggersRequest
- The parent resource name, for example projects/my-project-id.
- ListJobTriggersRequest::setPageToken() — Method in class ListJobTriggersRequest
- Optional page token to continue retrieval. Comes from previous call
to ListJobTriggers.
order_byandfiltershould not change for subsequent calls, but can be omitted if token is specified. - ListJobTriggersRequest::setPageSize() — Method in class ListJobTriggersRequest
- Optional size of the page, can be limited by a server.
- ListJobTriggersRequest::setOrderBy() — Method in class ListJobTriggersRequest
- Optional comma separated list of triggeredJob fields to order by, followed by 'asc/desc' postfix, i.e.
- ListJobTriggersResponse::setJobTriggers() — Method in class ListJobTriggersResponse
- List of triggeredJobs, up to page_size in ListJobTriggersRequest.
- ListJobTriggersResponse::setNextPageToken() — Method in class ListJobTriggersResponse
- If the next page is available then the next page token to be used in following ListJobTriggers request.
- Location::setByteRange() — Method in class Location
- Zero-based byte offsets delimiting the finding.
- Location::setCodepointRange() — Method in class Location
- Unicode character offsets delimiting the finding.
- Location::setContentLocations() — Method in class Location
- List of nested objects pointing to the precise location of the finding within the file or record.
- OutputStorageConfig::setTable() — Method in class OutputStorageConfig
- Store findings in an existing table or a new table in an existing
dataset. Each column in an existing table must have the same name, type,
and mode of a field in the
Findingobject. If table_id is not set a new one will be generated for you with the following format: dlp_googleapis_yyyy_mm_dd_[dlp_job_id]. Pacific timezone will be used for generating the date details. - OutputStorageConfig::setOutputSchema() — Method in class OutputStorageConfig
- Schema used for writing the findings. Columns are derived from the
Findingobject. If appending to an existing table, any columns from the predefined schema that are missing will be added. No columns in the existing table will be deleted. - PartitionId::setProjectId() — Method in class PartitionId
- The ID of the project to which the entities belong.
- PartitionId::setNamespaceId() — Method in class PartitionId
- If not empty, the ID of the namespace to which the entities belong.
- PrimitiveTransformation::setReplaceConfig() — Method in class PrimitiveTransformation
- Generated from protobuf field
.google.privacy.dlp.v2.ReplaceValueConfig replace_config = 1; - PrimitiveTransformation::setRedactConfig() — Method in class PrimitiveTransformation
- Generated from protobuf field
.google.privacy.dlp.v2.RedactConfig redact_config = 2; - PrimitiveTransformation::setCharacterMaskConfig() — Method in class PrimitiveTransformation
- Generated from protobuf field
.google.privacy.dlp.v2.CharacterMaskConfig character_mask_config = 3; - PrimitiveTransformation::setCryptoReplaceFfxFpeConfig() — Method in class PrimitiveTransformation
- Generated from protobuf field
.google.privacy.dlp.v2.CryptoReplaceFfxFpeConfig crypto_replace_ffx_fpe_config = 4; - PrimitiveTransformation::setFixedSizeBucketingConfig() — Method in class PrimitiveTransformation
- Generated from protobuf field
.google.privacy.dlp.v2.FixedSizeBucketingConfig fixed_size_bucketing_config = 5; - PrimitiveTransformation::setBucketingConfig() — Method in class PrimitiveTransformation
- Generated from protobuf field
.google.privacy.dlp.v2.BucketingConfig bucketing_config = 6; - PrimitiveTransformation::setReplaceWithInfoTypeConfig() — Method in class PrimitiveTransformation
- Generated from protobuf field
.google.privacy.dlp.v2.ReplaceWithInfoTypeConfig replace_with_info_type_config = 7; - PrimitiveTransformation::setTimePartConfig() — Method in class PrimitiveTransformation
- Generated from protobuf field
.google.privacy.dlp.v2.TimePartConfig time_part_config = 8; - PrimitiveTransformation::setCryptoHashConfig() — Method in class PrimitiveTransformation
- Generated from protobuf field
.google.privacy.dlp.v2.CryptoHashConfig crypto_hash_config = 9; - PrimitiveTransformation::setDateShiftConfig() — Method in class PrimitiveTransformation
- Generated from protobuf field
.google.privacy.dlp.v2.DateShiftConfig date_shift_config = 11; - PrivacyMetric::setNumericalStatsConfig() — Method in class PrivacyMetric
- Generated from protobuf field
.google.privacy.dlp.v2.PrivacyMetric.NumericalStatsConfig numerical_stats_config = 1; - PrivacyMetric::setCategoricalStatsConfig() — Method in class PrivacyMetric
- Generated from protobuf field
.google.privacy.dlp.v2.PrivacyMetric.CategoricalStatsConfig categorical_stats_config = 2; - PrivacyMetric::setKAnonymityConfig() — Method in class PrivacyMetric
- Generated from protobuf field
.google.privacy.dlp.v2.PrivacyMetric.KAnonymityConfig k_anonymity_config = 3; - PrivacyMetric::setLDiversityConfig() — Method in class PrivacyMetric
- Generated from protobuf field
.google.privacy.dlp.v2.PrivacyMetric.LDiversityConfig l_diversity_config = 4; - PrivacyMetric::setKMapEstimationConfig() — Method in class PrivacyMetric
- Generated from protobuf field
.google.privacy.dlp.v2.PrivacyMetric.KMapEstimationConfig k_map_estimation_config = 5; - PrivacyMetric_CategoricalStatsConfig::setField() — Method in class PrivacyMetric_CategoricalStatsConfig
- Field to compute categorical stats on. All column types are supported except for arrays and structs. However, it may be more informative to use NumericalStats when the field type is supported, depending on the data.
- PrivacyMetric_KAnonymityConfig::setQuasiIds() — Method in class PrivacyMetric_KAnonymityConfig
- Set of fields to compute k-anonymity over. When multiple fields are specified, they are considered a single composite key. Structs and repeated data types are not supported; however, nested fields are supported so long as they are not structs themselves or nested within a repeated field.
- PrivacyMetric_KAnonymityConfig::setEntityId() — Method in class PrivacyMetric_KAnonymityConfig
- Optional message indicating that multiple rows might be associated to a single individual. If the same entity_id is associated to multiple quasi-identifier tuples over distict rows, we consider the entire collection of tuples as the composite quasi-identifier. This collection is a multiset: the order in which the different tuples appear in the dataset is ignored, but their frequency is taken into account.
- PrivacyMetric_KMapEstimationConfig::setQuasiIds() — Method in class PrivacyMetric_KMapEstimationConfig
- Fields considered to be quasi-identifiers. No two columns can have the same tag. [required]
- PrivacyMetric_KMapEstimationConfig::setRegionCode() — Method in class PrivacyMetric_KMapEstimationConfig
- ISO 3166-1 alpha-2 region code to use in the statistical modeling.
- PrivacyMetric_KMapEstimationConfig::setAuxiliaryTables() — Method in class PrivacyMetric_KMapEstimationConfig
- Several auxiliary tables can be used in the analysis. Each custom_tag used to tag a quasi-identifiers column must appear in exactly one column of one auxiliary table.
- PrivacyMetric_KMapEstimationConfig_AuxiliaryTable::setTable() — Method in class PrivacyMetric_KMapEstimationConfig_AuxiliaryTable
- Auxiliary table location. [required]
- PrivacyMetric_KMapEstimationConfig_AuxiliaryTable::setQuasiIds() — Method in class PrivacyMetric_KMapEstimationConfig_AuxiliaryTable
- Quasi-identifier columns. [required]
- PrivacyMetric_KMapEstimationConfig_AuxiliaryTable::setRelativeFrequency() — Method in class PrivacyMetric_KMapEstimationConfig_AuxiliaryTable
- The relative frequency column must contain a floating-point number between 0 and 1 (inclusive). Null values are assumed to be zero.
- PrivacyMetric_KMapEstimationConfig_AuxiliaryTable_QuasiIdField::setField() — Method in class PrivacyMetric_KMapEstimationConfig_AuxiliaryTable_QuasiIdField
- Generated from protobuf field
.google.privacy.dlp.v2.FieldId field = 1; - PrivacyMetric_KMapEstimationConfig_AuxiliaryTable_QuasiIdField::setCustomTag() — Method in class PrivacyMetric_KMapEstimationConfig_AuxiliaryTable_QuasiIdField
- Generated from protobuf field
string custom_tag = 2; - PrivacyMetric_KMapEstimationConfig_TaggedField::setField() — Method in class PrivacyMetric_KMapEstimationConfig_TaggedField
- Identifies the column. [required]
- PrivacyMetric_KMapEstimationConfig_TaggedField::setInfoType() — Method in class PrivacyMetric_KMapEstimationConfig_TaggedField
- A column can be tagged with a InfoType to use the relevant public dataset as a statistical model of population, if available. We currently support US ZIP codes, region codes, ages and genders.
- PrivacyMetric_KMapEstimationConfig_TaggedField::setCustomTag() — Method in class PrivacyMetric_KMapEstimationConfig_TaggedField
- A column can be tagged with a custom tag. In this case, the user must indicate an auxiliary table that contains statistical information on the possible values of this column (below).
- PrivacyMetric_KMapEstimationConfig_TaggedField::setInferred() — Method in class PrivacyMetric_KMapEstimationConfig_TaggedField
- If no semantic tag is indicated, we infer the statistical model from the distribution of values in the input data
- PrivacyMetric_LDiversityConfig::setQuasiIds() — Method in class PrivacyMetric_LDiversityConfig
- Set of quasi-identifiers indicating how equivalence classes are defined for the l-diversity computation. When multiple fields are specified, they are considered a single composite key.
- PrivacyMetric_LDiversityConfig::setSensitiveAttribute() — Method in class PrivacyMetric_LDiversityConfig
- Sensitive field for computing the l-value.
- PrivacyMetric_NumericalStatsConfig::setField() — Method in class PrivacyMetric_NumericalStatsConfig
- Field to compute numerical stats on. Supported types are integer, float, date, datetime, timestamp, time.
- QuoteInfo::setDateTime() — Method in class QuoteInfo
- Generated from protobuf field
.google.privacy.dlp.v2.DateTime date_time = 2; - Range::setStart() — Method in class Range
- Index of the first character of the range (inclusive).
- Range::setEnd() — Method in class Range
- Index of the last character of the range (exclusive).
- RecordCondition::setExpressions() — Method in class RecordCondition
- An expression.
- RecordCondition_Condition::setField() — Method in class RecordCondition_Condition
- Field within the record this condition is evaluated against. [required]
- RecordCondition_Condition::setOperator() — Method in class RecordCondition_Condition
- Operator used to compare the field or infoType to the value. [required]
- RecordCondition_Condition::setValue() — Method in class RecordCondition_Condition
- Value to compare against. [Required, except for
EXISTStests.] - RecordCondition_Conditions::setConditions() — Method in class RecordCondition_Conditions
- Generated from protobuf field
repeated .google.privacy.dlp.v2.RecordCondition.Condition conditions = 1; - RecordCondition_Expressions::setLogicalOperator() — Method in class RecordCondition_Expressions
- The operator to apply to the result of conditions. Default and currently
only supported value is
AND. - RecordCondition_Expressions::setConditions() — Method in class RecordCondition_Expressions
- Generated from protobuf field
.google.privacy.dlp.v2.RecordCondition.Conditions conditions = 3; - RecordKey::setDatastoreKey() — Method in class RecordKey
- Generated from protobuf field
.google.privacy.dlp.v2.DatastoreKey datastore_key = 2; - RecordKey::setBigQueryKey() — Method in class RecordKey
- Generated from protobuf field
.google.privacy.dlp.v2.BigQueryKey big_query_key = 3; - RecordLocation::setRecordKey() — Method in class RecordLocation
- Key of the finding.
- RecordLocation::setFieldId() — Method in class RecordLocation
- Field id of the field containing the finding.
- RecordLocation::setTableLocation() — Method in class RecordLocation
- Location within a
ContentItem.Table. - RecordSuppression::setCondition() — Method in class RecordSuppression
- A condition that when it evaluates to true will result in the record being evaluated to be suppressed from the transformed content.
- RecordTransformations::setFieldTransformations() — Method in class RecordTransformations
- Transform the record by applying various field transformations.
- RecordTransformations::setRecordSuppressions() — Method in class RecordTransformations
- Configuration defining which records get suppressed entirely. Records that match any suppression rule are omitted from the output [optional].
- RedactImageRequest::setParent() — Method in class RedactImageRequest
- The parent resource name, for example projects/my-project-id.
- RedactImageRequest::setInspectConfig() — Method in class RedactImageRequest
- Configuration for the inspector.
- RedactImageRequest::setImageRedactionConfigs() — Method in class RedactImageRequest
- The configuration for specifying what content to redact from images.
- RedactImageRequest::setByteItem() — Method in class RedactImageRequest
- The content must be PNG, JPEG, SVG or BMP.
- RedactImageRequest_ImageRedactionConfig::setInfoType() — Method in class RedactImageRequest_ImageRedactionConfig
- Only one per info_type should be provided per request. If not specified, and redact_all_text is false, the DLP API will redact all text that it matches against all info_types that are found, but not specified in another ImageRedactionConfig.
- RedactImageRequest_ImageRedactionConfig::setRedactAllText() — Method in class RedactImageRequest_ImageRedactionConfig
- If true, all text found in the image, regardless whether it matches an info_type, is redacted.
- RedactImageRequest_ImageRedactionConfig::setRedactionColor() — Method in class RedactImageRequest_ImageRedactionConfig
- The color to use when redacting content from an image. If not specified, the default is black.
- RedactImageResponse::setRedactedImage() — Method in class RedactImageResponse
- The redacted image. The type will be the same as the original image.
- RedactImageResponse::setExtractedText() — Method in class RedactImageResponse
- If an image was being inspected and the InspectConfig's include_quote was set to true, then this field will include all text, if any, that was found in the image.
- ReidentifyContentRequest::setParent() — Method in class ReidentifyContentRequest
- The parent resource name.
- ReidentifyContentRequest::setReidentifyConfig() — Method in class ReidentifyContentRequest
- Configuration for the re-identification of the content item.
- ReidentifyContentRequest::setInspectConfig() — Method in class ReidentifyContentRequest
- Configuration for the inspector.
- ReidentifyContentRequest::setItem() — Method in class ReidentifyContentRequest
- The item to re-identify. Will be treated as text.
- ReidentifyContentRequest::setInspectTemplateName() — Method in class ReidentifyContentRequest
- Optional template to use. Any configuration directly specified in
inspect_configwill override those set in the template. Singular fields that are set in this request will replace their corresponding fields in the template. Repeated fields are appended. Singular sub-messages and groups are recursively merged. - ReidentifyContentRequest::setReidentifyTemplateName() — Method in class ReidentifyContentRequest
- Optional template to use. References an instance of
DeidentifyTemplate. - ReidentifyContentResponse::setItem() — Method in class ReidentifyContentResponse
- The re-identified item.
- ReidentifyContentResponse::setOverview() — Method in class ReidentifyContentResponse
- An overview of the changes that were made to the
item. - ReplaceValueConfig::setNewValue() — Method in class ReplaceValueConfig
- Value to replace it with.
- RiskAnalysisJobConfig::setPrivacyMetric() — Method in class RiskAnalysisJobConfig
- Privacy metric to compute.
- RiskAnalysisJobConfig::setSourceTable() — Method in class RiskAnalysisJobConfig
- Input dataset to compute metrics over.
- RiskAnalysisJobConfig::setActions() — Method in class RiskAnalysisJobConfig
- Actions to execute at the completion of the job. Are executed in the order provided.
- Schedule — Class in namespace Google\Cloud\Dlp\V2
- Schedule for triggeredJobs.
- Schedule::setRecurrencePeriodDuration() — Method in class Schedule
- With this option a job is started a regular periodic basis. For example: every 10 minutes.
- StorageConfig — Class in namespace Google\Cloud\Dlp\V2
- Shared message indicating Cloud storage type.
- StorageConfig::setDatastoreOptions() — Method in class StorageConfig
- Google Cloud Datastore options specification.
- StorageConfig::setCloudStorageOptions() — Method in class StorageConfig
- Google Cloud Storage options specification.
- StorageConfig::setBigQueryOptions() — Method in class StorageConfig
- BigQuery options specification.
- StorageConfig::setTimespanConfig() — Method in class StorageConfig
- Generated from protobuf field
.google.privacy.dlp.v2.StorageConfig.TimespanConfig timespan_config = 6; - StorageConfig_TimespanConfig — Class in namespace Google\Cloud\Dlp\V2
- Configuration of the timespan of the items to include in scanning.
- StorageConfig_TimespanConfig::setStartTime() — Method in class StorageConfig_TimespanConfig
- Exclude files older than this value.
- StorageConfig_TimespanConfig::setEndTime() — Method in class StorageConfig_TimespanConfig
- Exclude files newer than this value.
- StorageConfig_TimespanConfig::setTimestampField() — Method in class StorageConfig_TimespanConfig
- Specification of the field containing the timestamp of scanned items.
- StorageConfig_TimespanConfig::setEnableAutoPopulationOfTimespanConfig() — Method in class StorageConfig_TimespanConfig
- When the job is started by a JobTrigger we will automatically figure out a valid start_time to avoid scanning files that have not been modified since the last time the JobTrigger executed. This will be based on the time of the execution of the last run of the JobTrigger.
- Table::setHeaders() — Method in class Table
- Generated from protobuf field
repeated .google.privacy.dlp.v2.FieldId headers = 1; - Table::setRows() — Method in class Table
- Generated from protobuf field
repeated .google.privacy.dlp.v2.Table.Row rows = 2; - TableLocation::setRowIndex() — Method in class TableLocation
- The zero-based index of the row where the finding is located.
- Table_Row::setValues() — Method in class Table_Row
- Generated from protobuf field
repeated .google.privacy.dlp.v2.Value values = 1; - TimePartConfig::setPartToExtract() — Method in class TimePartConfig
- Generated from protobuf field
.google.privacy.dlp.v2.TimePartConfig.TimePart part_to_extract = 1; - TransformationOverview::setTransformedBytes() — Method in class TransformationOverview
- Total size in bytes that were transformed in some way.
- TransformationOverview::setTransformationSummaries() — Method in class TransformationOverview
- Transformations applied to the dataset.
- TransformationSummary::setInfoType() — Method in class TransformationSummary
- Set if the transformation was limited to a specific info_type.
- TransformationSummary::setField() — Method in class TransformationSummary
- Set if the transformation was limited to a specific FieldId.
- TransformationSummary::setTransformation() — Method in class TransformationSummary
- The specific transformation these stats apply to.
- TransformationSummary::setFieldTransformations() — Method in class TransformationSummary
- The field transformation that was applied.
- TransformationSummary::setRecordSuppress() — Method in class TransformationSummary
- The specific suppression option these stats apply to.
- TransformationSummary::setResults() — Method in class TransformationSummary
- Generated from protobuf field
repeated .google.privacy.dlp.v2.TransformationSummary.SummaryResult results = 4; - TransformationSummary::setTransformedBytes() — Method in class TransformationSummary
- Total size in bytes that were transformed in some way.
- TransformationSummary_SummaryResult::setCount() — Method in class TransformationSummary_SummaryResult
- Generated from protobuf field
int64 count = 1; - TransformationSummary_SummaryResult::setCode() — Method in class TransformationSummary_SummaryResult
- Generated from protobuf field
.google.privacy.dlp.v2.TransformationSummary.TransformationResultCode code = 2; - TransformationSummary_SummaryResult::setDetails() — Method in class TransformationSummary_SummaryResult
- A place for warnings or errors to show up if a transformation didn't work as expected.
- TransientCryptoKey::setName() — Method in class TransientCryptoKey
- Name of the key. [required] This is an arbitrary string used to differentiate different keys.
- UnwrappedCryptoKey::setKey() — Method in class UnwrappedCryptoKey
- The AES 128/192/256 bit key. [required]
- UpdateDeidentifyTemplateRequest::setName() — Method in class UpdateDeidentifyTemplateRequest
- Resource name of organization and deidentify template to be updated, for
example
organizations/433245324/deidentifyTemplates/432452342or projects/project-id/deidentifyTemplates/432452342. - UpdateDeidentifyTemplateRequest::setDeidentifyTemplate() — Method in class UpdateDeidentifyTemplateRequest
- New DeidentifyTemplate value.
- UpdateDeidentifyTemplateRequest::setUpdateMask() — Method in class UpdateDeidentifyTemplateRequest
- Mask to control which fields get updated.
- UpdateInspectTemplateRequest::setName() — Method in class UpdateInspectTemplateRequest
- Resource name of organization and inspectTemplate to be updated, for
example
organizations/433245324/inspectTemplates/432452342or projects/project-id/inspectTemplates/432452342. - UpdateInspectTemplateRequest::setInspectTemplate() — Method in class UpdateInspectTemplateRequest
- New InspectTemplate value.
- UpdateInspectTemplateRequest::setUpdateMask() — Method in class UpdateInspectTemplateRequest
- Mask to control which fields get updated.
- UpdateJobTriggerRequest::setName() — Method in class UpdateJobTriggerRequest
- Resource name of the project and the triggeredJob, for example
projects/dlp-test-project/jobTriggers/53234423. - UpdateJobTriggerRequest::setJobTrigger() — Method in class UpdateJobTriggerRequest
- New JobTrigger value.
- UpdateJobTriggerRequest::setUpdateMask() — Method in class UpdateJobTriggerRequest
- Mask to control which fields get updated.
- Value::setIntegerValue() — Method in class Value
- Generated from protobuf field
int64 integer_value = 1; - Value::setFloatValue() — Method in class Value
- Generated from protobuf field
double float_value = 2; - Value::setStringValue() — Method in class Value
- Generated from protobuf field
string string_value = 3; - Value::setBooleanValue() — Method in class Value
- Generated from protobuf field
bool boolean_value = 4; - Value::setTimestampValue() — Method in class Value
- Generated from protobuf field
.google.protobuf.Timestamp timestamp_value = 5; - Value::setTimeValue() — Method in class Value
- Generated from protobuf field
.google.type.TimeOfDay time_value = 6; - Value::setDateValue() — Method in class Value
- Generated from protobuf field
.google.type.Date date_value = 7; - Value::setDayOfWeekValue() — Method in class Value
- Generated from protobuf field
.google.type.DayOfWeek day_of_week_value = 8; - ValueFrequency::setValue() — Method in class ValueFrequency
- A value contained in the field in question.
- ValueFrequency::setCount() — Method in class ValueFrequency
- How many times the value is contained in the field.
- DeleteEventsRequest::setProjectName() — Method in class DeleteEventsRequest
- [Required] The resource name of the Google Cloud Platform project. Written
as
projects/plus the Google Cloud Platform project ID. - ErrorContext::setHttpRequest() — Method in class ErrorContext
- The HTTP request which was processed when the error was triggered.
- ErrorContext::setUser() — Method in class ErrorContext
- The user who caused or was affected by the crash.
- ErrorContext::setReportLocation() — Method in class ErrorContext
- The location in the source code where the decision was made to report the error, usually the place where it was logged.
- ErrorEvent::setEventTime() — Method in class ErrorEvent
- Time when the event occurred as provided in the error report.
- ErrorEvent::setServiceContext() — Method in class ErrorEvent
- The
ServiceContextfor which this error was reported. - ErrorEvent::setMessage() — Method in class ErrorEvent
- The stack trace that was reported or logged by the service.
- ErrorEvent::setContext() — Method in class ErrorEvent
- Data about the context in which the error occurred.
- ErrorGroup::setName() — Method in class ErrorGroup
- The group resource name.
- ErrorGroup::setGroupId() — Method in class ErrorGroup
- Group IDs are unique for a given project. If the same kind of error occurs in different service contexts, it will receive the same group ID.
- ErrorGroup::setTrackingIssues() — Method in class ErrorGroup
- Associated tracking issues.
- ErrorGroupStats::setGroup() — Method in class ErrorGroupStats
- Group data that is independent of the filter criteria.
- ErrorGroupStats::setCount() — Method in class ErrorGroupStats
- Approximate total number of events in the given group that match the filter criteria.
- ErrorGroupStats::setAffectedUsersCount() — Method in class ErrorGroupStats
- Approximate number of affected users in the given group that match the filter criteria.
- ErrorGroupStats::setTimedCounts() — Method in class ErrorGroupStats
- Approximate number of occurrences over time.
- ErrorGroupStats::setFirstSeenTime() — Method in class ErrorGroupStats
- Approximate first occurrence that was ever seen for this group and which matches the given filter criteria, ignoring the time_range that was specified in the request.
- ErrorGroupStats::setLastSeenTime() — Method in class ErrorGroupStats
- Approximate last occurrence that was ever seen for this group and which matches the given filter criteria, ignoring the time_range that was specified in the request.
- ErrorGroupStats::setAffectedServices() — Method in class ErrorGroupStats
- Service contexts with a non-zero error count for the given filter criteria. This list can be truncated if multiple services are affected.
- ErrorGroupStats::setNumAffectedServices() — Method in class ErrorGroupStats
- The total number of services with a non-zero error count for the given filter criteria.
- ErrorGroupStats::setRepresentative() — Method in class ErrorGroupStats
- An arbitrary event that is chosen as representative for the whole group.
- GetGroupRequest::setGroupName() — Method in class GetGroupRequest
- [Required] The group resource name. Written as
projects/projectID/groups/group_name. - HttpRequestContext::setMethod() — Method in class HttpRequestContext
- The type of HTTP request, such as
GET,POST, etc. - HttpRequestContext::setUrl() — Method in class HttpRequestContext
- The URL of the request.
- HttpRequestContext::setUserAgent() — Method in class HttpRequestContext
- The user agent information that is provided with the request.
- HttpRequestContext::setReferrer() — Method in class HttpRequestContext
- The referrer information that is provided with the request.
- HttpRequestContext::setResponseStatusCode() — Method in class HttpRequestContext
- The HTTP response status code for the request.
- HttpRequestContext::setRemoteIp() — Method in class HttpRequestContext
- The IP address from which the request originated.
- ListEventsRequest::setProjectName() — Method in class ListEventsRequest
- [Required] The resource name of the Google Cloud Platform project. Written
as
projects/plus the Google Cloud Platform project ID. - ListEventsRequest::setGroupId() — Method in class ListEventsRequest
- [Required] The group for which events shall be returned.
- ListEventsRequest::setServiceFilter() — Method in class ListEventsRequest
- [Optional] List only ErrorGroups which belong to a service context that matches the filter.
- ListEventsRequest::setTimeRange() — Method in class ListEventsRequest
- [Optional] List only data for the given time range.
- ListEventsRequest::setPageSize() — Method in class ListEventsRequest
- [Optional] The maximum number of results to return per response.
- ListEventsRequest::setPageToken() — Method in class ListEventsRequest
- [Optional] A
next_page_tokenprovided by a previous response. - ListEventsResponse::setErrorEvents() — Method in class ListEventsResponse
- The error events which match the given request.
- ListEventsResponse::setNextPageToken() — Method in class ListEventsResponse
- If non-empty, more results are available.
- ListEventsResponse::setTimeRangeBegin() — Method in class ListEventsResponse
- The timestamp specifies the start time to which the request was restricted.
- ListGroupStatsRequest::setProjectName() — Method in class ListGroupStatsRequest
- [Required] The resource name of the Google Cloud Platform project. Written
as
projects/plus the Google Cloud Platform project ID. - ListGroupStatsRequest::setGroupId() — Method in class ListGroupStatsRequest
- [Optional] List all
ErrorGroupStatswith these IDs. - ListGroupStatsRequest::setServiceFilter() — Method in class ListGroupStatsRequest
- [Optional] List only
ErrorGroupStatswhich belong to a service context that matches the filter. - ListGroupStatsRequest::setTimeRange() — Method in class ListGroupStatsRequest
- [Optional] List data for the given time range.
- ListGroupStatsRequest::setTimedCountDuration() — Method in class ListGroupStatsRequest
- [Optional] The preferred duration for a single returned
TimedCount. - ListGroupStatsRequest::setAlignment() — Method in class ListGroupStatsRequest
- [Optional] The alignment of the timed counts to be returned.
- ListGroupStatsRequest::setAlignmentTime() — Method in class ListGroupStatsRequest
- [Optional] Time where the timed counts shall be aligned if rounded alignment is chosen. Default is 00:00 UTC.
- ListGroupStatsRequest::setOrder() — Method in class ListGroupStatsRequest
- [Optional] The sort order in which the results are returned.
- ListGroupStatsRequest::setPageSize() — Method in class ListGroupStatsRequest
- [Optional] The maximum number of results to return per response.
- ListGroupStatsRequest::setPageToken() — Method in class ListGroupStatsRequest
- [Optional] A
next_page_tokenprovided by a previous response. To view additional results, pass this token along with the identical query parameters as the first request. - ListGroupStatsResponse::setErrorGroupStats() — Method in class ListGroupStatsResponse
- The error group stats which match the given request.
- ListGroupStatsResponse::setNextPageToken() — Method in class ListGroupStatsResponse
- If non-empty, more results are available.
- ListGroupStatsResponse::setTimeRangeBegin() — Method in class ListGroupStatsResponse
- The timestamp specifies the start time to which the request was restricted.
- QueryTimeRange::setPeriod() — Method in class QueryTimeRange
- Restricts the query to the specified time range.
- ReportErrorEventRequest::setProjectName() — Method in class ReportErrorEventRequest
- [Required] The resource name of the Google Cloud Platform project. Written
as
projects/plus the Google Cloud Platform project ID. - ReportErrorEventRequest::setEvent() — Method in class ReportErrorEventRequest
- [Required] The error event to be reported.
- ReportedErrorEvent::setEventTime() — Method in class ReportedErrorEvent
- [Optional] Time when the event occurred.
- ReportedErrorEvent::setServiceContext() — Method in class ReportedErrorEvent
- [Required] The service context in which this error has occurred.
- ReportedErrorEvent::setMessage() — Method in class ReportedErrorEvent
- [Required] A message describing the error. The message can contain an exception stack in one of the supported programming languages and formats.
- ReportedErrorEvent::setContext() — Method in class ReportedErrorEvent
- [Optional] A description of the context in which the error occurred.
- ServiceContext — Class in namespace Google\Cloud\ErrorReporting\V1beta1
- Describes a running service that sends errors.
- ServiceContext::setService() — Method in class ServiceContext
- An identifier of the service, such as the name of the
executable, job, or Google App Engine service name. This field is expected
to have a low number of values that are relatively stable over time, as
opposed to
version, which can be changed whenever new code is deployed. - ServiceContext::setVersion() — Method in class ServiceContext
- Represents the source code version that the developer provided, which could represent a version label or a Git SHA-1 hash, for example.
- ServiceContext::setResourceType() — Method in class ServiceContext
- Type of the MonitoredResource. List of possible values: https://cloud.google.com/monitoring/api/resources Value is set automatically for incoming errors and must not be set when reporting errors.
- ServiceContextFilter — Class in namespace Google\Cloud\ErrorReporting\V1beta1
- Specifies criteria for filtering a subset of service contexts.
- ServiceContextFilter::setService() — Method in class ServiceContextFilter
- [Optional] The exact value to match against
ServiceContext.service. - ServiceContextFilter::setVersion() — Method in class ServiceContextFilter
- [Optional] The exact value to match against
ServiceContext.version. - ServiceContextFilter::setResourceType() — Method in class ServiceContextFilter
- [Optional] The exact value to match against
ServiceContext.resource_type. - SourceLocation — Class in namespace Google\Cloud\ErrorReporting\V1beta1
- Indicates a location in the source code of the service for which errors are reported.
- SourceLocation::setFilePath() — Method in class SourceLocation
- The source code filename, which can include a truncated relative path, or a full path from a production machine.
- SourceLocation::setLineNumber() — Method in class SourceLocation
- 1-based. 0 indicates that the line number is unknown.
- SourceLocation::setFunctionName() — Method in class SourceLocation
- Human-readable name of a function or method.
- TimedCount::setCount() — Method in class TimedCount
- Approximate number of occurrences in the given time period.
- TimedCount::setStartTime() — Method in class TimedCount
- Start of the time period to which
countrefers (included). - TimedCount::setEndTime() — Method in class TimedCount
- End of the time period to which
countrefers (excluded). - TrackingIssue::setUrl() — Method in class TrackingIssue
- A URL pointing to a related entry in an issue tracking system.
- UpdateGroupRequest::setGroup() — Method in class UpdateGroupRequest
- [Required] The group which replaces the resource on the server.
- ArrayValue::setValues() — Method in class ArrayValue
- Values in the array.
- BatchGetDocumentsRequest::setDatabase() — Method in class BatchGetDocumentsRequest
- The database name. In the format:
projects/{project_id}/databases/{database_id}. - BatchGetDocumentsRequest::setDocuments() — Method in class BatchGetDocumentsRequest
- The names of the documents to retrieve. In the format:
projects/{project_id}/databases/{database_id}/documents/{document_path}. - BatchGetDocumentsRequest::setMask() — Method in class BatchGetDocumentsRequest
- The fields to return. If not set, returns all fields.
- BatchGetDocumentsRequest::setTransaction() — Method in class BatchGetDocumentsRequest
- Reads documents in a transaction.
- BatchGetDocumentsRequest::setNewTransaction() — Method in class BatchGetDocumentsRequest
- Starts a new transaction and reads the documents.
- BatchGetDocumentsRequest::setReadTime() — Method in class BatchGetDocumentsRequest
- Reads documents as they were at the given time.
- BatchGetDocumentsResponse::setFound() — Method in class BatchGetDocumentsResponse
- A document that was requested.
- BatchGetDocumentsResponse::setMissing() — Method in class BatchGetDocumentsResponse
- A document name that was requested but does not exist. In the format:
projects/{project_id}/databases/{database_id}/documents/{document_path}. - BatchGetDocumentsResponse::setTransaction() — Method in class BatchGetDocumentsResponse
- The transaction that was started as part of this request.
- BatchGetDocumentsResponse::setReadTime() — Method in class BatchGetDocumentsResponse
- The time at which the document was read.
- BeginTransactionRequest::setDatabase() — Method in class BeginTransactionRequest
- The database name. In the format:
projects/{project_id}/databases/{database_id}. - BeginTransactionRequest::setOptions() — Method in class BeginTransactionRequest
- The options for the transaction.
- BeginTransactionResponse::setTransaction() — Method in class BeginTransactionResponse
- The transaction that was started.
- CommitRequest::setDatabase() — Method in class CommitRequest
- The database name. In the format:
projects/{project_id}/databases/{database_id}. - CommitRequest::setWrites() — Method in class CommitRequest
- The writes to apply.
- CommitRequest::setTransaction() — Method in class CommitRequest
- If set, applies all writes in this transaction, and commits it.
- CommitResponse::setWriteResults() — Method in class CommitResponse
- The result of applying the writes.
- CommitResponse::setCommitTime() — Method in class CommitResponse
- The time at which the commit occurred.
- CreateDocumentRequest::setParent() — Method in class CreateDocumentRequest
- The parent resource. For example:
projects/{project_id}/databases/{database_id}/documentsorprojects/{project_id}/databases/{database_id}/documents/chatrooms/{chatroom_id} - CreateDocumentRequest::setCollectionId() — Method in class CreateDocumentRequest
- The collection ID, relative to
parent, to list. For example:chatrooms. - CreateDocumentRequest::setDocumentId() — Method in class CreateDocumentRequest
- The client-assigned document ID to use for this document.
- CreateDocumentRequest::setDocument() — Method in class CreateDocumentRequest
- The document to create.
namemust not be set. - CreateDocumentRequest::setMask() — Method in class CreateDocumentRequest
- The fields to return. If not set, returns all fields.
- Cursor::setValues() — Method in class Cursor
- The values that represent a position, in the order they appear in the order by clause of a query.
- Cursor::setBefore() — Method in class Cursor
- If the position is just before or just after the given values, relative to the sort order defined by the query.
- DeleteDocumentRequest::setName() — Method in class DeleteDocumentRequest
- The resource name of the Document to delete. In the format:
projects/{project_id}/databases/{database_id}/documents/{document_path}. - DeleteDocumentRequest::setCurrentDocument() — Method in class DeleteDocumentRequest
- An optional precondition on the document.
- Document::setName() — Method in class Document
- The resource name of the document, for example
projects/{project_id}/databases/{database_id}/documents/{document_path}. - Document::setFields() — Method in class Document
- The document's fields.
- Document::setCreateTime() — Method in class Document
- Output only. The time at which the document was created.
- Document::setUpdateTime() — Method in class Document
- Output only. The time at which the document was last changed.
- DocumentChange::setDocument() — Method in class DocumentChange
- The new state of the [Document][google.firestore.v1beta1.Document].
- DocumentChange::setTargetIds() — Method in class DocumentChange
- A set of target IDs of targets that match this document.
- DocumentChange::setRemovedTargetIds() — Method in class DocumentChange
- A set of target IDs for targets that no longer match this document.
- DocumentDelete::setDocument() — Method in class DocumentDelete
- The resource name of the [Document][google.firestore.v1beta1.Document] that was deleted.
- DocumentDelete::setRemovedTargetIds() — Method in class DocumentDelete
- A set of target IDs for targets that previously matched this entity.
- DocumentDelete::setReadTime() — Method in class DocumentDelete
- The read timestamp at which the delete was observed.
- DocumentMask::setFieldPaths() — Method in class DocumentMask
- The list of field paths in the mask. See [Document.fields][google.firestore.v1beta1.Document.fields] for a field path syntax reference.
- DocumentRemove::setDocument() — Method in class DocumentRemove
- The resource name of the [Document][google.firestore.v1beta1.Document] that has gone out of view.
- DocumentRemove::setRemovedTargetIds() — Method in class DocumentRemove
- A set of target IDs for targets that previously matched this document.
- DocumentRemove::setReadTime() — Method in class DocumentRemove
- The read timestamp at which the remove was observed.
- DocumentTransform::setDocument() — Method in class DocumentTransform
- The name of the document to transform.
- DocumentTransform::setFieldTransforms() — Method in class DocumentTransform
- The list of transformations to apply to the fields of the document, in order.
- DocumentTransform_FieldTransform::setFieldPath() — Method in class DocumentTransform_FieldTransform
- The path of the field. See [Document.fields][google.firestore.v1beta1.Document.fields] for the field path syntax reference.
- DocumentTransform_FieldTransform::setSetToServerValue() — Method in class DocumentTransform_FieldTransform
- Sets the field to the given server value.
- ExistenceFilter::setTargetId() — Method in class ExistenceFilter
- The target ID to which this filter applies.
- ExistenceFilter::setCount() — Method in class ExistenceFilter
- The total count of documents that match [target_id][google.firestore.v1beta1.ExistenceFilter.target_id].
- GetDocumentRequest::setName() — Method in class GetDocumentRequest
- The resource name of the Document to get. In the format:
projects/{project_id}/databases/{database_id}/documents/{document_path}. - GetDocumentRequest::setMask() — Method in class GetDocumentRequest
- The fields to return. If not set, returns all fields.
- GetDocumentRequest::setTransaction() — Method in class GetDocumentRequest
- Reads the document in a transaction.
- GetDocumentRequest::setReadTime() — Method in class GetDocumentRequest
- Reads the version of the document at the given time.
- ListCollectionIdsRequest::setParent() — Method in class ListCollectionIdsRequest
- The parent document. In the format:
projects/{project_id}/databases/{database_id}/documents/{document_path}. - ListCollectionIdsRequest::setPageSize() — Method in class ListCollectionIdsRequest
- The maximum number of results to return.
- ListCollectionIdsRequest::setPageToken() — Method in class ListCollectionIdsRequest
- A page token. Must be a value from [ListCollectionIdsResponse][google.firestore.v1beta1.ListCollectionIdsResponse].
- ListCollectionIdsResponse::setCollectionIds() — Method in class ListCollectionIdsResponse
- The collection ids.
- ListCollectionIdsResponse::setNextPageToken() — Method in class ListCollectionIdsResponse
- A page token that may be used to continue the list.
- ListDocumentsRequest::setParent() — Method in class ListDocumentsRequest
- The parent resource name. In the format:
projects/{project_id}/databases/{database_id}/documentsorprojects/{project_id}/databases/{database_id}/documents/{document_path}. - ListDocumentsRequest::setCollectionId() — Method in class ListDocumentsRequest
- The collection ID, relative to
parent, to list. For example:chatroomsormessages. - ListDocumentsRequest::setPageSize() — Method in class ListDocumentsRequest
- The maximum number of documents to return.
- ListDocumentsRequest::setPageToken() — Method in class ListDocumentsRequest
- The
next_page_tokenvalue returned from a previous List request, if any. - ListDocumentsRequest::setOrderBy() — Method in class ListDocumentsRequest
- The order to sort results by. For example:
priority desc, name. - ListDocumentsRequest::setMask() — Method in class ListDocumentsRequest
- The fields to return. If not set, returns all fields.
- ListDocumentsRequest::setTransaction() — Method in class ListDocumentsRequest
- Reads documents in a transaction.
- ListDocumentsRequest::setReadTime() — Method in class ListDocumentsRequest
- Reads documents as they were at the given time.
- ListDocumentsRequest::setShowMissing() — Method in class ListDocumentsRequest
- If the list should show missing documents. A missing document is a document that does not exist but has sub-documents. These documents will be returned with a key but will not have fields, [Document.create_time][google.firestore.v1beta1.Document.create_time], or [Document.update_time][google.firestore.v1beta1.Document.update_time] set.
- ListDocumentsResponse::setDocuments() — Method in class ListDocumentsResponse
- The Documents found.
- ListDocumentsResponse::setNextPageToken() — Method in class ListDocumentsResponse
- The next page token.
- ListenRequest::setDatabase() — Method in class ListenRequest
- The database name. In the format:
projects/{project_id}/databases/{database_id}. - ListenRequest::setAddTarget() — Method in class ListenRequest
- A target to add to this stream.
- ListenRequest::setRemoveTarget() — Method in class ListenRequest
- The ID of a target to remove from this stream.
- ListenRequest::setLabels() — Method in class ListenRequest
- Labels associated with this target change.
- ListenResponse::setTargetChange() — Method in class ListenResponse
- Targets have changed.
- ListenResponse::setDocumentChange() — Method in class ListenResponse
- A [Document][google.firestore.v1beta1.Document] has changed.
- ListenResponse::setDocumentDelete() — Method in class ListenResponse
- A [Document][google.firestore.v1beta1.Document] has been deleted.
- ListenResponse::setDocumentRemove() — Method in class ListenResponse
- A [Document][google.firestore.v1beta1.Document] has been removed from a target (because it is no longer relevant to that target).
- ListenResponse::setFilter() — Method in class ListenResponse
- A filter to apply to the set of documents previously returned for the given target.
- MapValue::setFields() — Method in class MapValue
- The map's fields.
- Precondition::setExists() — Method in class Precondition
- When set to
true, the target document must exist. - Precondition::setUpdateTime() — Method in class Precondition
- When set, the target document must exist and have been last updated at that time.
- RollbackRequest::setDatabase() — Method in class RollbackRequest
- The database name. In the format:
projects/{project_id}/databases/{database_id}. - RollbackRequest::setTransaction() — Method in class RollbackRequest
- The transaction to roll back.
- RunQueryRequest::setParent() — Method in class RunQueryRequest
- The parent resource name. In the format:
projects/{project_id}/databases/{database_id}/documentsorprojects/{project_id}/databases/{database_id}/documents/{document_path}. - RunQueryRequest::setStructuredQuery() — Method in class RunQueryRequest
- A structured query.
- RunQueryRequest::setTransaction() — Method in class RunQueryRequest
- Reads documents in a transaction.
- RunQueryRequest::setNewTransaction() — Method in class RunQueryRequest
- Starts a new transaction and reads the documents.
- RunQueryRequest::setReadTime() — Method in class RunQueryRequest
- Reads documents as they were at the given time.
- RunQueryResponse::setTransaction() — Method in class RunQueryResponse
- The transaction that was started as part of this request.
- RunQueryResponse::setDocument() — Method in class RunQueryResponse
- A query result.
- RunQueryResponse::setReadTime() — Method in class RunQueryResponse
- The time at which the document was read. This may be monotonically
increasing; in this case, the previous documents in the result stream are
guaranteed not to have changed between their
read_timeand this one. - RunQueryResponse::setSkippedResults() — Method in class RunQueryResponse
- The number of results that have been skipped due to an offset between the last response and the current response.
- StructuredQuery — Class in namespace Google\Cloud\Firestore\V1beta1
- A Firestore query.
- StructuredQuery::setSelect() — Method in class StructuredQuery
- The projection to return.
- StructuredQuery::setFrom() — Method in class StructuredQuery
- The collections to query.
- StructuredQuery::setWhere() — Method in class StructuredQuery
- The filter to apply.
- StructuredQuery::setOrderBy() — Method in class StructuredQuery
- The order to apply to the query results.
- StructuredQuery::setStartAt() — Method in class StructuredQuery
- A starting point for the query results.
- StructuredQuery::setEndAt() — Method in class StructuredQuery
- A end point for the query results.
- StructuredQuery::setOffset() — Method in class StructuredQuery
- The number of results to skip.
- StructuredQuery::setLimit() — Method in class StructuredQuery
- The maximum number of results to return.
- StructuredQuery_CollectionSelector — Class in namespace Google\Cloud\Firestore\V1beta1
- A selection of a collection, such as
messages as m1. - StructuredQuery_CollectionSelector::setCollectionId() — Method in class StructuredQuery_CollectionSelector
- The collection ID.
- StructuredQuery_CollectionSelector::setAllDescendants() — Method in class StructuredQuery_CollectionSelector
- When false, selects only collections that are immediate children of
the
parentspecified in the containingRunQueryRequest. - StructuredQuery_CompositeFilter — Class in namespace Google\Cloud\Firestore\V1beta1
- A filter that merges multiple other filters using the given operator.
- StructuredQuery_CompositeFilter::setOp() — Method in class StructuredQuery_CompositeFilter
- The operator for combining multiple filters.
- StructuredQuery_CompositeFilter::setFilters() — Method in class StructuredQuery_CompositeFilter
- The list of filters to combine.
- StructuredQuery_CompositeFilter_Operator — Class in namespace Google\Cloud\Firestore\V1beta1
- A composite filter operator.
- StructuredQuery_Direction — Class in namespace Google\Cloud\Firestore\V1beta1
- A sort direction.
- StructuredQuery_FieldFilter — Class in namespace Google\Cloud\Firestore\V1beta1
- A filter on a specific field.
- StructuredQuery_FieldFilter::setField() — Method in class StructuredQuery_FieldFilter
- The field to filter by.
- StructuredQuery_FieldFilter::setOp() — Method in class StructuredQuery_FieldFilter
- The operator to filter by.
- StructuredQuery_FieldFilter::setValue() — Method in class StructuredQuery_FieldFilter
- The value to compare to.
- StructuredQuery_FieldFilter_Operator — Class in namespace Google\Cloud\Firestore\V1beta1
- A field filter operator.
- StructuredQuery_FieldReference — Class in namespace Google\Cloud\Firestore\V1beta1
- A reference to a field, such as
max(messages.time) as max_time. - StructuredQuery_FieldReference::setFieldPath() — Method in class StructuredQuery_FieldReference
- Generated from protobuf field
string field_path = 2; - StructuredQuery_Filter — Class in namespace Google\Cloud\Firestore\V1beta1
- A filter.
- StructuredQuery_Filter::setCompositeFilter() — Method in class StructuredQuery_Filter
- A composite filter.
- StructuredQuery_Filter::setFieldFilter() — Method in class StructuredQuery_Filter
- A filter on a document field.
- StructuredQuery_Filter::setUnaryFilter() — Method in class StructuredQuery_Filter
- A filter that takes exactly one argument.
- StructuredQuery_Order — Class in namespace Google\Cloud\Firestore\V1beta1
- An order on a field.
- StructuredQuery_Order::setField() — Method in class StructuredQuery_Order
- The field to order by.
- StructuredQuery_Order::setDirection() — Method in class StructuredQuery_Order
- The direction to order by. Defaults to
ASCENDING. - StructuredQuery_Projection — Class in namespace Google\Cloud\Firestore\V1beta1
- The projection of document's fields to return.
- StructuredQuery_Projection::setFields() — Method in class StructuredQuery_Projection
- The fields to return.
- StructuredQuery_UnaryFilter — Class in namespace Google\Cloud\Firestore\V1beta1
- A filter with a single operand.
- StructuredQuery_UnaryFilter::setOp() — Method in class StructuredQuery_UnaryFilter
- The unary operator to apply.
- StructuredQuery_UnaryFilter::setField() — Method in class StructuredQuery_UnaryFilter
- The field to which to apply the operator.
- StructuredQuery_UnaryFilter_Operator — Class in namespace Google\Cloud\Firestore\V1beta1
- A unary operator.
- Target::setQuery() — Method in class Target
- A target specified by a query.
- Target::setDocuments() — Method in class Target
- A target specified by a set of document names.
- Target::setResumeToken() — Method in class Target
- A resume token from a prior [TargetChange][google.firestore.v1beta1.TargetChange] for an identical target.
- Target::setReadTime() — Method in class Target
- Start listening after a specific
read_time. - Target::setTargetId() — Method in class Target
- A client provided target ID.
- Target::setOnce() — Method in class Target
- If the target should be removed once it is current and consistent.
- TargetChange::setTargetChangeType() — Method in class TargetChange
- The type of change that occurred.
- TargetChange::setTargetIds() — Method in class TargetChange
- The target IDs of targets that have changed.
- TargetChange::setCause() — Method in class TargetChange
- The error that resulted in this change, if applicable.
- TargetChange::setResumeToken() — Method in class TargetChange
- A token that can be used to resume the stream for the given
target_ids, or all targets iftarget_idsis empty. - TargetChange::setReadTime() — Method in class TargetChange
- The consistent
read_timefor the giventarget_ids(omitted when the target_ids are not at a consistent snapshot). - Target_DocumentsTarget::setDocuments() — Method in class Target_DocumentsTarget
- The names of the documents to retrieve. In the format:
projects/{project_id}/databases/{database_id}/documents/{document_path}. - Target_QueryTarget::setParent() — Method in class Target_QueryTarget
- The parent resource name. In the format:
projects/{project_id}/databases/{database_id}/documentsorprojects/{project_id}/databases/{database_id}/documents/{document_path}. - Target_QueryTarget::setStructuredQuery() — Method in class Target_QueryTarget
- A structured query.
- TransactionOptions::setReadOnly() — Method in class TransactionOptions
- The transaction can only be used for read operations.
- TransactionOptions::setReadWrite() — Method in class TransactionOptions
- The transaction can be used for both read and write operations.
- TransactionOptions_ReadOnly::setReadTime() — Method in class TransactionOptions_ReadOnly
- Reads documents at the given time.
- TransactionOptions_ReadWrite::setRetryTransaction() — Method in class TransactionOptions_ReadWrite
- An optional transaction to retry.
- UpdateDocumentRequest::setDocument() — Method in class UpdateDocumentRequest
- The updated document.
- UpdateDocumentRequest::setUpdateMask() — Method in class UpdateDocumentRequest
- The fields to update.
- UpdateDocumentRequest::setMask() — Method in class UpdateDocumentRequest
- The fields to return. If not set, returns all fields.
- UpdateDocumentRequest::setCurrentDocument() — Method in class UpdateDocumentRequest
- An optional precondition on the document.
- Value::setNullValue() — Method in class Value
- A null value.
- Value::setBooleanValue() — Method in class Value
- A boolean value.
- Value::setIntegerValue() — Method in class Value
- An integer value.
- Value::setDoubleValue() — Method in class Value
- A double value.
- Value::setTimestampValue() — Method in class Value
- A timestamp value.
- Value::setStringValue() — Method in class Value
- A string value.
- Value::setBytesValue() — Method in class Value
- A bytes value.
- Value::setReferenceValue() — Method in class Value
- A reference to a document. For example:
projects/{project_id}/databases/{database_id}/documents/{document_path}. - Value::setGeoPointValue() — Method in class Value
- A geo point value representing a point on the surface of Earth.
- Value::setArrayValue() — Method in class Value
- An array value.
- Value::setMapValue() — Method in class Value
- A map value.
- Write::setUpdate() — Method in class Write
- A document to write.
- Write::setDelete() — Method in class Write
- A document name to delete. In the format:
projects/{project_id}/databases/{database_id}/documents/{document_path}. - Write::setTransform() — Method in class Write
- Applies a tranformation to a document.
- Write::setUpdateMask() — Method in class Write
- The fields to update in this write.
- Write::setCurrentDocument() — Method in class Write
- An optional precondition on the document.
- WriteRequest::setDatabase() — Method in class WriteRequest
- The database name. In the format:
projects/{project_id}/databases/{database_id}. - WriteRequest::setStreamId() — Method in class WriteRequest
- The ID of the write stream to resume.
- WriteRequest::setWrites() — Method in class WriteRequest
- The writes to apply.
- WriteRequest::setStreamToken() — Method in class WriteRequest
- A stream token that was previously sent by the server.
- WriteRequest::setLabels() — Method in class WriteRequest
- Labels associated with this write request.
- WriteResponse::setStreamId() — Method in class WriteResponse
- The ID of the stream.
- WriteResponse::setStreamToken() — Method in class WriteResponse
- A token that represents the position of this response in the stream.
- WriteResponse::setWriteResults() — Method in class WriteResponse
- The result of applying the writes.
- WriteResponse::setCommitTime() — Method in class WriteResponse
- The time at which the commit occurred.
- WriteResult::setUpdateTime() — Method in class WriteResult
- The last update time of the document after applying the write. Not set
after a
delete. - WriteResult::setTransformResults() — Method in class WriteResult
- The results of applying each [DocumentTransform.FieldTransform][google.firestore.v1beta1.DocumentTransform.FieldTransform], in the same order.
- Binding::setRole() — Method in class Binding
- Role that is assigned to
members. - Binding::setMembers() — Method in class Binding
- Specifies the identities requesting access for a Cloud Platform resource.
- BindingDelta::setAction() — Method in class BindingDelta
- The action that was performed on a Binding.
- BindingDelta::setRole() — Method in class BindingDelta
- Role that is assigned to
members. - BindingDelta::setMember() — Method in class BindingDelta
- A single identity requesting access for a Cloud Platform resource.
- GetIamPolicyRequest::setResource() — Method in class GetIamPolicyRequest
- REQUIRED: The resource for which the policy is being requested.
- IAMPolicyGrpcClient::SetIamPolicy() — Method in class IAMPolicyGrpcClient
- Sets the access control policy on the specified resource. Replaces any existing policy.
- Policy::setVersion() — Method in class Policy
- Version of the
Policy. The default version is 0. - Policy::setBindings() — Method in class Policy
- Associates a list of
membersto arole. - Policy::setEtag() — Method in class Policy
etagis used for optimistic concurrency control as a way to help prevent simultaneous updates of a policy from overwriting each other.- PolicyDelta::setBindingDeltas() — Method in class PolicyDelta
- The delta for Bindings between two policies.
- SetIamPolicyRequest — Class in namespace Google\Cloud\Iam\V1
- Request message for
SetIamPolicymethod. - SetIamPolicyRequest::setResource() — Method in class SetIamPolicyRequest
- REQUIRED: The resource for which the policy is being specified.
- SetIamPolicyRequest::setPolicy() — Method in class SetIamPolicyRequest
- REQUIRED: The complete policy to be applied to the
resource. The size of the policy is limited to a few 10s of KB. An empty policy is a valid policy but certain Cloud Platform services (such as Projects) might reject them. - TestIamPermissionsRequest::setResource() — Method in class TestIamPermissionsRequest
- REQUIRED: The resource for which the policy detail is being requested.
- TestIamPermissionsRequest::setPermissions() — Method in class TestIamPermissionsRequest
- The set of permissions to check for the
resource. Permissions with wildcards (such as '' or 'storage.') are not allowed. For more information see IAM Overview. - TestIamPermissionsResponse::setPermissions() — Method in class TestIamPermissionsResponse
- A subset of
TestPermissionsRequest.permissionsthat the caller is allowed. - CreateDeviceRegistryRequest::setParent() — Method in class CreateDeviceRegistryRequest
- The project and cloud region where this device registry must be created.
- CreateDeviceRegistryRequest::setDeviceRegistry() — Method in class CreateDeviceRegistryRequest
- The device registry. The field
namemust be empty. The server will generate that field from the device registryidprovided and theparentfield. - CreateDeviceRequest::setParent() — Method in class CreateDeviceRequest
- The name of the device registry where this device should be created.
- CreateDeviceRequest::setDevice() — Method in class CreateDeviceRequest
- The device registration details. The field
namemust be empty. The server will generate that field from the device registryidprovided and theparentfield. - DeleteDeviceRegistryRequest::setName() — Method in class DeleteDeviceRegistryRequest
- The name of the device registry. For example,
projects/example-project/locations/us-central1/registries/my-registry. - DeleteDeviceRequest::setName() — Method in class DeleteDeviceRequest
- The name of the device. For example,
projects/p0/locations/us-central1/registries/registry0/devices/device0orprojects/p0/locations/us-central1/registries/registry0/devices/{num_id}. - Device::setId() — Method in class Device
- The user-defined device identifier. The device ID must be unique within a device registry.
- Device::setName() — Method in class Device
- The resource path name. For example,
projects/p1/locations/us-central1/registries/registry0/devices/dev0orprojects/p1/locations/us-central1/registries/registry0/devices/{num_id}. - Device::setNumId() — Method in class Device
- [Output only] A server-defined unique numeric ID for the device. This is a more compact way to identify devices, and it is globally unique.
- Device::setCredentials() — Method in class Device
- The credentials used to authenticate this device. To allow credential
rotation without interruption, multiple device credentials can be bound to
this device. No more than 3 credentials can be bound to a single device at
a time. When new credentials are added to a device, they are verified
against the registry credentials. For details, see the description of the
DeviceRegistry.credentialsfield. - Device::setLastHeartbeatTime() — Method in class Device
- [Output only] The last time an MQTT
PINGREQwas received. This field applies only to devices connecting through MQTT. MQTT clients usually only sendPINGREQmessages if the connection is idle, and no other messages have been sent. Timestamps are periodically collected and written to storage; they may be stale by a few minutes. - Device::setLastEventTime() — Method in class Device
- [Output only] The last time a telemetry event was received. Timestamps are periodically collected and written to storage; they may be stale by a few minutes.
- Device::setLastStateTime() — Method in class Device
- [Output only] The last time a state event was received. Timestamps are periodically collected and written to storage; they may be stale by a few minutes.
- Device::setLastConfigAckTime() — Method in class Device
- [Output only] The last time a cloud-to-device config version acknowledgment was received from the device. This field is only for configurations sent through MQTT.
- Device::setLastConfigSendTime() — Method in class Device
- [Output only] The last time a cloud-to-device config version was sent to the device.
- Device::setBlocked() — Method in class Device
- If a device is blocked, connections or requests from this device will fail.
- Device::setLastErrorTime() — Method in class Device
- [Output only] The time the most recent error occurred, such as a failure to publish to Cloud Pub/Sub. This field is the timestamp of 'last_error_status'.
- Device::setLastErrorStatus() — Method in class Device
- [Output only] The error message of the most recent error, such as a failure to publish to Cloud Pub/Sub. 'last_error_time' is the timestamp of this field. If no errors have occurred, this field has an empty message and the status code 0 == OK. Otherwise, this field is expected to have a status code other than OK.
- Device::setConfig() — Method in class Device
- The most recent device configuration, which is eventually sent from
Cloud IoT Core to the device. If not present on creation, the
configuration will be initialized with an empty payload and version value
of
1. To update this field after creation, use theDeviceManager.ModifyCloudToDeviceConfigmethod. - Device::setState() — Method in class Device
- [Output only] The state most recently received from the device. If no state has been reported, this field is not present.
- Device::setMetadata() — Method in class Device
- The metadata key-value pairs assigned to the device. This metadata is not interpreted or indexed by Cloud IoT Core. It can be used to add contextual information for the device.
- DeviceConfig::setVersion() — Method in class DeviceConfig
- [Output only] The version of this update. The version number is assigned by
the server, and is always greater than 0 after device creation. The
version must be 0 on the
CreateDevicerequest if aconfigis specified; the response ofCreateDevicewill always have a value of 1. - DeviceConfig::setCloudUpdateTime() — Method in class DeviceConfig
- [Output only] The time at which this configuration version was updated in Cloud IoT Core. This timestamp is set by the server.
- DeviceConfig::setDeviceAckTime() — Method in class DeviceConfig
- [Output only] The time at which Cloud IoT Core received the acknowledgment from the device, indicating that the device has received this configuration version. If this field is not present, the device has not yet acknowledged that it received this version. Note that when the config was sent to the device, many config versions may have been available in Cloud IoT Core while the device was disconnected, and on connection, only the latest version is sent to the device. Some versions may never be sent to the device, and therefore are never acknowledged. This timestamp is set by Cloud IoT Core.
- DeviceConfig::setBinaryData() — Method in class DeviceConfig
- The device configuration data.
- DeviceCredential::setPublicKey() — Method in class DeviceCredential
- A public key used to verify the signature of JSON Web Tokens (JWTs).
- DeviceCredential::setExpirationTime() — Method in class DeviceCredential
- [Optional] The time at which this credential becomes invalid. This credential will be ignored for new client authentication requests after this timestamp; however, it will not be automatically deleted.
- DeviceManagerGrpcClient::SetIamPolicy() — Method in class DeviceManagerGrpcClient
- Sets the access control policy on the specified resource. Replaces any existing policy.
- DeviceRegistry::setId() — Method in class DeviceRegistry
- The identifier of this device registry. For example,
myRegistry. - DeviceRegistry::setName() — Method in class DeviceRegistry
- The resource path name. For example,
projects/example-project/locations/us-central1/registries/my-registry. - DeviceRegistry::setEventNotificationConfigs() — Method in class DeviceRegistry
- The configuration for notification of telemetry events received from the device. All telemetry events that were successfully published by the device and acknowledged by Cloud IoT Core are guaranteed to be delivered to Cloud Pub/Sub. If multiple configurations match a message, only the first matching configuration is used. If you try to publish a device telemetry event using MQTT without specifying a Cloud Pub/Sub topic for the device's registry, the connection closes automatically. If you try to do so using an HTTP connection, an error is returned. Up to 10 configurations may be provided.
- DeviceRegistry::setStateNotificationConfig() — Method in class DeviceRegistry
- The configuration for notification of new states received from the device.
- DeviceRegistry::setMqttConfig() — Method in class DeviceRegistry
- The MQTT configuration for this device registry.
- DeviceRegistry::setHttpConfig() — Method in class DeviceRegistry
- The DeviceService (HTTP) configuration for this device registry.
- DeviceRegistry::setCredentials() — Method in class DeviceRegistry
- The credentials used to verify the device credentials. No more than 10 credentials can be bound to a single registry at a time. The verification process occurs at the time of device creation or update. If this field is empty, no verification is performed. Otherwise, the credentials of a newly created device or added credentials of an updated device should be signed with one of these registry credentials.
- DeviceState::setUpdateTime() — Method in class DeviceState
- [Output only] The time at which this state version was updated in Cloud IoT Core.
- DeviceState::setBinaryData() — Method in class DeviceState
- The device state data.
- EventNotificationConfig::setSubfolderMatches() — Method in class EventNotificationConfig
- If the subfolder name matches this string exactly, this configuration will be used. The string must not include the leading '/' character. If empty, all strings are matched. This field is used only for telemetry events; subfolders are not supported for state changes.
- EventNotificationConfig::setPubsubTopicName() — Method in class EventNotificationConfig
- A Cloud Pub/Sub topic name. For example,
projects/myProject/topics/deviceEvents. - GetDeviceRegistryRequest::setName() — Method in class GetDeviceRegistryRequest
- The name of the device registry. For example,
projects/example-project/locations/us-central1/registries/my-registry. - GetDeviceRequest::setName() — Method in class GetDeviceRequest
- The name of the device. For example,
projects/p0/locations/us-central1/registries/registry0/devices/device0orprojects/p0/locations/us-central1/registries/registry0/devices/{num_id}. - GetDeviceRequest::setFieldMask() — Method in class GetDeviceRequest
- The fields of the
Deviceresource to be returned in the response. If the field mask is unset or empty, all fields are returned. - HttpConfig::setHttpEnabledState() — Method in class HttpConfig
- If enabled, allows devices to use DeviceService via the HTTP protocol.
- ListDeviceConfigVersionsRequest::setName() — Method in class ListDeviceConfigVersionsRequest
- The name of the device. For example,
projects/p0/locations/us-central1/registries/registry0/devices/device0orprojects/p0/locations/us-central1/registries/registry0/devices/{num_id}. - ListDeviceConfigVersionsRequest::setNumVersions() — Method in class ListDeviceConfigVersionsRequest
- The number of versions to list. Versions are listed in decreasing order of the version number. The maximum number of versions retained is 10. If this value is zero, it will return all the versions available.
- ListDeviceConfigVersionsResponse::setDeviceConfigs() — Method in class ListDeviceConfigVersionsResponse
- The device configuration for the last few versions. Versions are listed in decreasing order, starting from the most recent one.
- ListDeviceRegistriesRequest::setParent() — Method in class ListDeviceRegistriesRequest
- The project and cloud region path. For example,
projects/example-project/locations/us-central1. - ListDeviceRegistriesRequest::setPageSize() — Method in class ListDeviceRegistriesRequest
- The maximum number of registries to return in the response. If this value
is zero, the service will select a default size. A call may return fewer
objects than requested, but if there is a non-empty
page_token, it indicates that more entries are available. - ListDeviceRegistriesRequest::setPageToken() — Method in class ListDeviceRegistriesRequest
- The value returned by the last
ListDeviceRegistriesResponse; indicates that this is a continuation of a priorListDeviceRegistriescall, and that the system should return the next page of data. - ListDeviceRegistriesResponse::setDeviceRegistries() — Method in class ListDeviceRegistriesResponse
- The registries that matched the query.
- ListDeviceRegistriesResponse::setNextPageToken() — Method in class ListDeviceRegistriesResponse
- If not empty, indicates that there may be more registries that match the
request; this value should be passed in a new
ListDeviceRegistriesRequest. - ListDeviceStatesRequest::setName() — Method in class ListDeviceStatesRequest
- The name of the device. For example,
projects/p0/locations/us-central1/registries/registry0/devices/device0orprojects/p0/locations/us-central1/registries/registry0/devices/{num_id}. - ListDeviceStatesRequest::setNumStates() — Method in class ListDeviceStatesRequest
- The number of states to list. States are listed in descending order of update time. The maximum number of states retained is 10. If this value is zero, it will return all the states available.
- ListDeviceStatesResponse::setDeviceStates() — Method in class ListDeviceStatesResponse
- The last few device states. States are listed in descending order of server update time, starting from the most recent one.
- ListDevicesRequest::setParent() — Method in class ListDevicesRequest
- The device registry path. Required. For example,
projects/my-project/locations/us-central1/registries/my-registry. - ListDevicesRequest::setDeviceNumIds() — Method in class ListDevicesRequest
- A list of device numerical ids. If empty, it will ignore this field. This field cannot hold more than 10,000 entries.
- ListDevicesRequest::setDeviceIds() — Method in class ListDevicesRequest
- A list of device string identifiers. If empty, it will ignore this field.
- ListDevicesRequest::setFieldMask() — Method in class ListDevicesRequest
- The fields of the
Deviceresource to be returned in the response. The fieldsid, andnum_idare always returned by default, along with any other fields specified. - ListDevicesRequest::setPageSize() — Method in class ListDevicesRequest
- The maximum number of devices to return in the response. If this value
is zero, the service will select a default size. A call may return fewer
objects than requested, but if there is a non-empty
page_token, it indicates that more entries are available. - ListDevicesRequest::setPageToken() — Method in class ListDevicesRequest
- The value returned by the last
ListDevicesResponse; indicates that this is a continuation of a priorListDevicescall, and that the system should return the next page of data. - ListDevicesResponse::setDevices() — Method in class ListDevicesResponse
- The devices that match the request.
- ListDevicesResponse::setNextPageToken() — Method in class ListDevicesResponse
- If not empty, indicates that there may be more devices that match the
request; this value should be passed in a new
ListDevicesRequest. - ModifyCloudToDeviceConfigRequest::setName() — Method in class ModifyCloudToDeviceConfigRequest
- The name of the device. For example,
projects/p0/locations/us-central1/registries/registry0/devices/device0orprojects/p0/locations/us-central1/registries/registry0/devices/{num_id}. - ModifyCloudToDeviceConfigRequest::setVersionToUpdate() — Method in class ModifyCloudToDeviceConfigRequest
- The version number to update. If this value is zero, it will not check the version number of the server and will always update the current version; otherwise, this update will fail if the version number found on the server does not match this version number. This is used to support multiple simultaneous updates without losing data.
- ModifyCloudToDeviceConfigRequest::setBinaryData() — Method in class ModifyCloudToDeviceConfigRequest
- The configuration data for the device.
- MqttConfig::setMqttEnabledState() — Method in class MqttConfig
- If enabled, allows connections using the MQTT protocol. Otherwise, MQTT connections to this registry will fail.
- PublicKeyCertificate::setFormat() — Method in class PublicKeyCertificate
- The certificate format.
- PublicKeyCertificate::setCertificate() — Method in class PublicKeyCertificate
- The certificate data.
- PublicKeyCertificate::setX509Details() — Method in class PublicKeyCertificate
- [Output only] The certificate details. Used only for X.509 certificates.
- PublicKeyCredential::setFormat() — Method in class PublicKeyCredential
- The format of the key.
- PublicKeyCredential::setKey() — Method in class PublicKeyCredential
- The key data.
- RegistryCredential::setPublicKeyCertificate() — Method in class RegistryCredential
- A public key certificate used to verify the device credentials.
- StateNotificationConfig — Class in namespace Google\Cloud\Iot\V1
- The configuration for notification of new states received from the device.
- StateNotificationConfig::setPubsubTopicName() — Method in class StateNotificationConfig
- A Cloud Pub/Sub topic name. For example,
projects/myProject/topics/deviceEvents. - UpdateDeviceRegistryRequest::setDeviceRegistry() — Method in class UpdateDeviceRegistryRequest
- The new values for the device registry. The
idfield must be empty, and thenamefield must indicate the path of the resource. For example,projects/example-project/locations/us-central1/registries/my-registry. - UpdateDeviceRegistryRequest::setUpdateMask() — Method in class UpdateDeviceRegistryRequest
- Only updates the
device_registryfields indicated by this mask. - UpdateDeviceRequest::setDevice() — Method in class UpdateDeviceRequest
- The new values for the device registry. The
idandnum_idfields must be empty, and the fieldnamemust specify the name path. For example,projects/p0/locations/us-central1/registries/registry0/devices/device0orprojects/p0/locations/us-central1/registries/registry0/devices/{num_id}. - UpdateDeviceRequest::setUpdateMask() — Method in class UpdateDeviceRequest
- Only updates the
devicefields indicated by this mask. - X509CertificateDetails::setIssuer() — Method in class X509CertificateDetails
- The entity that signed the certificate.
- X509CertificateDetails::setSubject() — Method in class X509CertificateDetails
- The entity the certificate and public key belong to.
- X509CertificateDetails::setStartTime() — Method in class X509CertificateDetails
- The time the certificate becomes valid.
- X509CertificateDetails::setExpiryTime() — Method in class X509CertificateDetails
- The time the certificate becomes invalid.
- X509CertificateDetails::setSignatureAlgorithm() — Method in class X509CertificateDetails
- The algorithm used to sign the certificate.
- X509CertificateDetails::setPublicKeyType() — Method in class X509CertificateDetails
- The type of public key in the certificate.
- AnalyzeEntitiesRequest::setDocument() — Method in class AnalyzeEntitiesRequest
- Input document.
- AnalyzeEntitiesRequest::setEncodingType() — Method in class AnalyzeEntitiesRequest
- The encoding type used by the API to calculate offsets.
- AnalyzeEntitiesResponse::setEntities() — Method in class AnalyzeEntitiesResponse
- The recognized entities in the input document.
- AnalyzeEntitiesResponse::setLanguage() — Method in class AnalyzeEntitiesResponse
- The language of the text, which will be the same as the language specified in the request or, if not specified, the automatically-detected language.
- AnalyzeEntitySentimentRequest::setDocument() — Method in class AnalyzeEntitySentimentRequest
- Input document.
- AnalyzeEntitySentimentRequest::setEncodingType() — Method in class AnalyzeEntitySentimentRequest
- The encoding type used by the API to calculate offsets.
- AnalyzeEntitySentimentResponse::setEntities() — Method in class AnalyzeEntitySentimentResponse
- The recognized entities in the input document with associated sentiments.
- AnalyzeEntitySentimentResponse::setLanguage() — Method in class AnalyzeEntitySentimentResponse
- The language of the text, which will be the same as the language specified in the request or, if not specified, the automatically-detected language.
- AnalyzeSentimentRequest::setDocument() — Method in class AnalyzeSentimentRequest
- Input document.
- AnalyzeSentimentRequest::setEncodingType() — Method in class AnalyzeSentimentRequest
- The encoding type used by the API to calculate sentence offsets for the sentence sentiment.
- AnalyzeSentimentResponse::setDocumentSentiment() — Method in class AnalyzeSentimentResponse
- The overall sentiment of the input document.
- AnalyzeSentimentResponse::setLanguage() — Method in class AnalyzeSentimentResponse
- The language of the text, which will be the same as the language specified in the request or, if not specified, the automatically-detected language.
- AnalyzeSentimentResponse::setSentences() — Method in class AnalyzeSentimentResponse
- The sentiment for all the sentences in the document.
- AnalyzeSyntaxRequest::setDocument() — Method in class AnalyzeSyntaxRequest
- Input document.
- AnalyzeSyntaxRequest::setEncodingType() — Method in class AnalyzeSyntaxRequest
- The encoding type used by the API to calculate offsets.
- AnalyzeSyntaxResponse::setSentences() — Method in class AnalyzeSyntaxResponse
- Sentences in the input document.
- AnalyzeSyntaxResponse::setTokens() — Method in class AnalyzeSyntaxResponse
- Tokens, along with their syntactic information, in the input document.
- AnalyzeSyntaxResponse::setLanguage() — Method in class AnalyzeSyntaxResponse
- The language of the text, which will be the same as the language specified in the request or, if not specified, the automatically-detected language.
- AnnotateTextRequest::setDocument() — Method in class AnnotateTextRequest
- Input document.
- AnnotateTextRequest::setFeatures() — Method in class AnnotateTextRequest
- The enabled features.
- AnnotateTextRequest::setEncodingType() — Method in class AnnotateTextRequest
- The encoding type used by the API to calculate offsets.
- AnnotateTextRequest_Features::setExtractSyntax() — Method in class AnnotateTextRequest_Features
- Extract syntax information.
- AnnotateTextRequest_Features::setExtractEntities() — Method in class AnnotateTextRequest_Features
- Extract entities.
- AnnotateTextRequest_Features::setExtractDocumentSentiment() — Method in class AnnotateTextRequest_Features
- Extract document-level sentiment.
- AnnotateTextRequest_Features::setExtractEntitySentiment() — Method in class AnnotateTextRequest_Features
- Extract entities and their associated sentiment.
- AnnotateTextRequest_Features::setClassifyText() — Method in class AnnotateTextRequest_Features
- Classify the full document into categories.
- AnnotateTextResponse::setSentences() — Method in class AnnotateTextResponse
- Sentences in the input document. Populated if the user enables [AnnotateTextRequest.Features.extract_syntax][google.cloud.language.v1beta2.AnnotateTextRequest.Features.extract_syntax].
- AnnotateTextResponse::setTokens() — Method in class AnnotateTextResponse
- Tokens, along with their syntactic information, in the input document.
- AnnotateTextResponse::setEntities() — Method in class AnnotateTextResponse
- Entities, along with their semantic information, in the input document.
- AnnotateTextResponse::setDocumentSentiment() — Method in class AnnotateTextResponse
- The overall sentiment for the document. Populated if the user enables [AnnotateTextRequest.Features.extract_document_sentiment][google.cloud.language.v1beta2.AnnotateTextRequest.Features.extract_document_sentiment].
- AnnotateTextResponse::setLanguage() — Method in class AnnotateTextResponse
- The language of the text, which will be the same as the language specified in the request or, if not specified, the automatically-detected language.
- AnnotateTextResponse::setCategories() — Method in class AnnotateTextResponse
- Categories identified in the input document.
- ClassificationCategory::setName() — Method in class ClassificationCategory
- The name of the category representing the document.
- ClassificationCategory::setConfidence() — Method in class ClassificationCategory
- The classifier's confidence of the category. Number represents how certain the classifier is that this category represents the given text.
- ClassifyTextRequest::setDocument() — Method in class ClassifyTextRequest
- Input document.
- ClassifyTextResponse::setCategories() — Method in class ClassifyTextResponse
- Categories representing the input document.
- DependencyEdge::setHeadTokenIndex() — Method in class DependencyEdge
- Represents the head of this token in the dependency tree.
- DependencyEdge::setLabel() — Method in class DependencyEdge
- The parse label for the token.
- $Document#source — Property in class Document
- Document::setType() — Method in class Document
- Required. If the type is not set or is
TYPE_UNSPECIFIED, returns anINVALID_ARGUMENTerror. - Document::setContent() — Method in class Document
- The content of the input in string format.
- Document::setGcsContentUri() — Method in class Document
- The Google Cloud Storage URI where the file content is located.
- Document::setLanguage() — Method in class Document
- The language of the document (if not specified, the language is
automatically detected). Both ISO and BCP-47 language codes are
accepted.
Language Support lists currently supported languages for each API method. - Entity::setName() — Method in class Entity
- The representative name for the entity.
- Entity::setType() — Method in class Entity
- The entity type.
- Entity::setMetadata() — Method in class Entity
- Metadata associated with the entity.
- Entity::setSalience() — Method in class Entity
- The salience score associated with the entity in the [0, 1.0] range.
- Entity::setMentions() — Method in class Entity
- The mentions of this entity in the input document. The API currently supports proper noun mentions.
- Entity::setSentiment() — Method in class Entity
- For calls to [AnalyzeEntitySentiment][] or if [AnnotateTextRequest.Features.extract_entity_sentiment][google.cloud.language.v1beta2.AnnotateTextRequest.Features.extract_entity_sentiment] is set to true, this field will contain the aggregate sentiment expressed for this entity in the provided document.
- EntityMention::setText() — Method in class EntityMention
- The mention text.
- EntityMention::setType() — Method in class EntityMention
- The type of the entity mention.
- EntityMention::setSentiment() — Method in class EntityMention
- For calls to [AnalyzeEntitySentiment][] or if [AnnotateTextRequest.Features.extract_entity_sentiment][google.cloud.language.v1beta2.AnnotateTextRequest.Features.extract_entity_sentiment] is set to true, this field will contain the sentiment expressed for this mention of the entity in the provided document.
- PartOfSpeech::setTag() — Method in class PartOfSpeech
- The part of speech tag.
- PartOfSpeech::setAspect() — Method in class PartOfSpeech
- The grammatical aspect.
- PartOfSpeech::setCase() — Method in class PartOfSpeech
- The grammatical case.
- PartOfSpeech::setForm() — Method in class PartOfSpeech
- The grammatical form.
- PartOfSpeech::setGender() — Method in class PartOfSpeech
- The grammatical gender.
- PartOfSpeech::setMood() — Method in class PartOfSpeech
- The grammatical mood.
- PartOfSpeech::setNumber() — Method in class PartOfSpeech
- The grammatical number.
- PartOfSpeech::setPerson() — Method in class PartOfSpeech
- The grammatical person.
- PartOfSpeech::setProper() — Method in class PartOfSpeech
- The grammatical properness.
- PartOfSpeech::setReciprocity() — Method in class PartOfSpeech
- The grammatical reciprocity.
- PartOfSpeech::setTense() — Method in class PartOfSpeech
- The grammatical tense.
- PartOfSpeech::setVoice() — Method in class PartOfSpeech
- The grammatical voice.
- Sentence — Class in namespace Google\Cloud\Language\V1beta2
- Represents a sentence in the input document.
- Sentence::setText() — Method in class Sentence
- The sentence text.
- Sentence::setSentiment() — Method in class Sentence
- For calls to [AnalyzeSentiment][] or if [AnnotateTextRequest.Features.extract_document_sentiment][google.cloud.language.v1beta2.AnnotateTextRequest.Features.extract_document_sentiment] is set to true, this field will contain the sentiment for the sentence.
- Sentiment — Class in namespace Google\Cloud\Language\V1beta2
- Represents the feeling associated with the entire text or entities in the text.
- Sentiment::setMagnitude() — Method in class Sentiment
- A non-negative number in the [0, +inf) range, which represents the absolute magnitude of sentiment regardless of score (positive or negative).
- Sentiment::setScore() — Method in class Sentiment
- Sentiment score between -1.0 (negative sentiment) and 1.0 (positive sentiment).
- TextSpan::setContent() — Method in class TextSpan
- The content of the output text.
- TextSpan::setBeginOffset() — Method in class TextSpan
- The API calculates the beginning offset of the content in the original document according to the [EncodingType][google.cloud.language.v1beta2.EncodingType] specified in the API request.
- Token::setText() — Method in class Token
- The token text.
- Token::setPartOfSpeech() — Method in class Token
- Parts of speech tag for this token.
- Token::setDependencyEdge() — Method in class Token
- Dependency tree parse for this token.
- Token::setLemma() — Method in class Token
- Lemma of the token.
- HttpRequest::setRequestMethod() — Method in class HttpRequest
- The request method. Examples:
"GET","HEAD","PUT","POST". - HttpRequest::setRequestUrl() — Method in class HttpRequest
- The scheme (http, https), the host name, the path and the query portion of the URL that was requested.
- HttpRequest::setRequestSize() — Method in class HttpRequest
- The size of the HTTP request message in bytes, including the request headers and the request body.
- HttpRequest::setStatus() — Method in class HttpRequest
- The response code indicating the status of response.
- HttpRequest::setResponseSize() — Method in class HttpRequest
- The size of the HTTP response message sent back to the client, in bytes, including the response headers and the response body.
- HttpRequest::setUserAgent() — Method in class HttpRequest
- The user agent sent by the client. Example:
"Mozilla/4.0 (compatible; MSIE 6.0; Windows 98; Q312461; .NET CLR 1.0.3705)". - HttpRequest::setRemoteIp() — Method in class HttpRequest
- The IP address (IPv4 or IPv6) of the client that issued the HTTP
request. Examples:
"192.168.1.1","FE80::0202:B3FF:FE1E:8329". - HttpRequest::setServerIp() — Method in class HttpRequest
- The IP address (IPv4 or IPv6) of the origin server that the request was sent to.
- HttpRequest::setReferer() — Method in class HttpRequest
- The referer URL of the request, as defined in HTTP/1.1 Header Field Definitions.
- HttpRequest::setLatency() — Method in class HttpRequest
- The request processing latency on the server, from the time the request was received until the response was sent.
- HttpRequest::setCacheLookup() — Method in class HttpRequest
- Whether or not a cache lookup was attempted.
- HttpRequest::setCacheHit() — Method in class HttpRequest
- Whether or not an entity was served from cache (with or without validation).
- HttpRequest::setCacheValidatedWithOriginServer() — Method in class HttpRequest
- Whether or not the response was validated with the origin server before
being served from cache. This field is only meaningful if
cache_hitis True. - HttpRequest::setCacheFillBytes() — Method in class HttpRequest
- The number of HTTP response bytes inserted into cache. Set only when a cache fill was attempted.
- HttpRequest::setProtocol() — Method in class HttpRequest
- Protocol used for the request. Examples: "HTTP/1.1", "HTTP/2", "websocket"
- CreateExclusionRequest::setParent() — Method in class CreateExclusionRequest
- Required. The parent resource in which to create the exclusion:
"projects/[PROJECT_ID]"
"organizations/[ORGANIZATION_ID]"
"billingAccounts/[BILLING_ACCOUNT_ID]"
"folders/[FOLDER_ID]"
Examples:
"projects/my-logging-project","organizations/123456789". - CreateExclusionRequest::setExclusion() — Method in class CreateExclusionRequest
- Required. The new exclusion, whose
nameparameter is an exclusion name that is not already used in the parent resource. - CreateLogMetricRequest::setParent() — Method in class CreateLogMetricRequest
- The resource name of the project in which to create the metric: "projects/[PROJECT_ID]" The new metric must be provided in the request.
- CreateLogMetricRequest::setMetric() — Method in class CreateLogMetricRequest
- The new logs-based metric, which must not have an identifier that already exists.
- CreateSinkRequest::setParent() — Method in class CreateSinkRequest
- Required. The resource in which to create the sink:
"projects/[PROJECT_ID]"
"organizations/[ORGANIZATION_ID]"
"billingAccounts/[BILLING_ACCOUNT_ID]"
"folders/[FOLDER_ID]"
Examples:
"projects/my-logging-project","organizations/123456789". - CreateSinkRequest::setSink() — Method in class CreateSinkRequest
- Required. The new sink, whose
nameparameter is a sink identifier that is not already in use. - CreateSinkRequest::setUniqueWriterIdentity() — Method in class CreateSinkRequest
- Optional. Determines the kind of IAM identity returned as
writer_identityin the new sink. If this value is omitted or set to false, and if the sink's parent is a project, then the value returned aswriter_identityis the same group or service account used by Stackdriver Logging before the addition of writer identities to this API. The sink's destination must be in the same project as the sink itself. - DeleteExclusionRequest::setName() — Method in class DeleteExclusionRequest
- Required. The resource name of an existing exclusion to delete:
"projects/[PROJECT_ID]/exclusions/[EXCLUSION_ID]"
"organizations/[ORGANIZATION_ID]/exclusions/[EXCLUSION_ID]"
"billingAccounts/[BILLING_ACCOUNT_ID]/exclusions/[EXCLUSION_ID]"
"folders/[FOLDER_ID]/exclusions/[EXCLUSION_ID]"
Example:
"projects/my-project-id/exclusions/my-exclusion-id". - DeleteLogMetricRequest::setMetricName() — Method in class DeleteLogMetricRequest
- The resource name of the metric to delete: "projects/[PROJECT_ID]/metrics/[METRIC_ID]"
- DeleteLogRequest::setLogName() — Method in class DeleteLogRequest
- Required. The resource name of the log to delete:
"projects/[PROJECT_ID]/logs/[LOG_ID]"
"organizations/[ORGANIZATION_ID]/logs/[LOG_ID]"
"billingAccounts/[BILLING_ACCOUNT_ID]/logs/[LOG_ID]"
"folders/[FOLDER_ID]/logs/[LOG_ID]"
[LOG_ID]must be URL-encoded. For example,"projects/my-project-id/logs/syslog","organizations/1234567890/logs/cloudresourcemanager.googleapis.com%2Factivity". - DeleteSinkRequest::setSinkName() — Method in class DeleteSinkRequest
- Required. The full resource name of the sink to delete, including the
parent resource and the sink identifier:
"projects/[PROJECT_ID]/sinks/[SINK_ID]"
"organizations/[ORGANIZATION_ID]/sinks/[SINK_ID]"
"billingAccounts/[BILLING_ACCOUNT_ID]/sinks/[SINK_ID]"
"folders/[FOLDER_ID]/sinks/[SINK_ID]"
Example:
"projects/my-project-id/sinks/my-sink-id". - GetExclusionRequest::setName() — Method in class GetExclusionRequest
- Required. The resource name of an existing exclusion:
"projects/[PROJECT_ID]/exclusions/[EXCLUSION_ID]"
"organizations/[ORGANIZATION_ID]/exclusions/[EXCLUSION_ID]"
"billingAccounts/[BILLING_ACCOUNT_ID]/exclusions/[EXCLUSION_ID]"
"folders/[FOLDER_ID]/exclusions/[EXCLUSION_ID]"
Example:
"projects/my-project-id/exclusions/my-exclusion-id". - GetLogMetricRequest::setMetricName() — Method in class GetLogMetricRequest
- The resource name of the desired metric: "projects/[PROJECT_ID]/metrics/[METRIC_ID]"
- GetSinkRequest::setSinkName() — Method in class GetSinkRequest
- Required. The resource name of the sink:
"projects/[PROJECT_ID]/sinks/[SINK_ID]"
"organizations/[ORGANIZATION_ID]/sinks/[SINK_ID]"
"billingAccounts/[BILLING_ACCOUNT_ID]/sinks/[SINK_ID]"
"folders/[FOLDER_ID]/sinks/[SINK_ID]"
Example:
"projects/my-project-id/sinks/my-sink-id". - ListExclusionsRequest::setParent() — Method in class ListExclusionsRequest
- Required. The parent resource whose exclusions are to be listed.
- ListExclusionsRequest::setPageToken() — Method in class ListExclusionsRequest
- Optional. If present, then retrieve the next batch of results from the
preceding call to this method.
pageTokenmust be the value ofnextPageTokenfrom the previous response. The values of other method parameters should be identical to those in the previous call. - ListExclusionsRequest::setPageSize() — Method in class ListExclusionsRequest
- Optional. The maximum number of results to return from this request.
- ListExclusionsResponse::setExclusions() — Method in class ListExclusionsResponse
- A list of exclusions.
- ListExclusionsResponse::setNextPageToken() — Method in class ListExclusionsResponse
- If there might be more results than appear in this response, then
nextPageTokenis included. To get the next set of results, call the same method again using the value ofnextPageTokenaspageToken. - ListLogEntriesRequest::setProjectIds() — Method in class ListLogEntriesRequest
- Deprecated. Use
resource_namesinstead. One or more project identifiers or project numbers from which to retrieve log entries. Example:"my-project-1A". If present, these project identifiers are converted to resource name format and added to the list of resources inresource_names. - ListLogEntriesRequest::setResourceNames() — Method in class ListLogEntriesRequest
- Required. Names of one or more parent resources from which to
retrieve log entries:
"projects/[PROJECT_ID]"
"organizations/[ORGANIZATION_ID]"
"billingAccounts/[BILLING_ACCOUNT_ID]"
"folders/[FOLDER_ID]"
Projects listed in the
project_idsfield are added to this list. - ListLogEntriesRequest::setFilter() — Method in class ListLogEntriesRequest
- Optional. A filter that chooses which log entries to return. See Advanced
Logs Filters. Only log entries that
match the filter are returned. An empty filter matches all log entries in
the resources listed in
resource_names. Referencing a parent resource that is not listed inresource_nameswill cause the filter to return no results. - ListLogEntriesRequest::setOrderBy() — Method in class ListLogEntriesRequest
- Optional. How the results should be sorted. Presently, the only permitted
values are
"timestamp asc"(default) and"timestamp desc". The first option returns entries in order of increasing values ofLogEntry.timestamp(oldest first), and the second option returns entries in order of decreasing timestamps (newest first). Entries with equal timestamps are returned in order of theirinsert_idvalues. - ListLogEntriesRequest::setPageSize() — Method in class ListLogEntriesRequest
- Optional. The maximum number of results to return from this request.
- ListLogEntriesRequest::setPageToken() — Method in class ListLogEntriesRequest
- Optional. If present, then retrieve the next batch of results from the
preceding call to this method.
page_tokenmust be the value ofnext_page_tokenfrom the previous response. The values of other method parameters should be identical to those in the previous call. - ListLogEntriesResponse::setEntries() — Method in class ListLogEntriesResponse
- A list of log entries. If
entriesis empty,nextPageTokenmay still be returned, indicating that more entries may exist. SeenextPageTokenfor more information. - ListLogEntriesResponse::setNextPageToken() — Method in class ListLogEntriesResponse
- If there might be more results than those appearing in this response, then
nextPageTokenis included. To get the next set of results, call this method again using the value ofnextPageTokenaspageToken. - ListLogMetricsRequest::setParent() — Method in class ListLogMetricsRequest
- Required. The name of the project containing the metrics: "projects/[PROJECT_ID]"
- ListLogMetricsRequest::setPageToken() — Method in class ListLogMetricsRequest
- Optional. If present, then retrieve the next batch of results from the
preceding call to this method.
pageTokenmust be the value ofnextPageTokenfrom the previous response. The values of other method parameters should be identical to those in the previous call. - ListLogMetricsRequest::setPageSize() — Method in class ListLogMetricsRequest
- Optional. The maximum number of results to return from this request.
- ListLogMetricsResponse::setMetrics() — Method in class ListLogMetricsResponse
- A list of logs-based metrics.
- ListLogMetricsResponse::setNextPageToken() — Method in class ListLogMetricsResponse
- If there might be more results than appear in this response, then
nextPageTokenis included. To get the next set of results, call this method again using the value ofnextPageTokenaspageToken. - ListLogsRequest::setParent() — Method in class ListLogsRequest
- Required. The resource name that owns the logs: "projects/[PROJECT_ID]" "organizations/[ORGANIZATION_ID]" "billingAccounts/[BILLING_ACCOUNT_ID]" "folders/[FOLDER_ID]"
- ListLogsRequest::setPageSize() — Method in class ListLogsRequest
- Optional. The maximum number of results to return from this request.
- ListLogsRequest::setPageToken() — Method in class ListLogsRequest
- Optional. If present, then retrieve the next batch of results from the
preceding call to this method.
pageTokenmust be the value ofnextPageTokenfrom the previous response. The values of other method parameters should be identical to those in the previous call. - ListLogsResponse::setLogNames() — Method in class ListLogsResponse
- A list of log names. For example,
"projects/my-project/syslog"or"organizations/123/cloudresourcemanager.googleapis.com%2Factivity". - ListLogsResponse::setNextPageToken() — Method in class ListLogsResponse
- If there might be more results than those appearing in this response, then
nextPageTokenis included. To get the next set of results, call this method again using the value ofnextPageTokenaspageToken. - ListMonitoredResourceDescriptorsRequest::setPageSize() — Method in class ListMonitoredResourceDescriptorsRequest
- Optional. The maximum number of results to return from this request.
- ListMonitoredResourceDescriptorsRequest::setPageToken() — Method in class ListMonitoredResourceDescriptorsRequest
- Optional. If present, then retrieve the next batch of results from the
preceding call to this method.
pageTokenmust be the value ofnextPageTokenfrom the previous response. The values of other method parameters should be identical to those in the previous call. - ListMonitoredResourceDescriptorsResponse::setResourceDescriptors() — Method in class ListMonitoredResourceDescriptorsResponse
- A list of resource descriptors.
- ListMonitoredResourceDescriptorsResponse::setNextPageToken() — Method in class ListMonitoredResourceDescriptorsResponse
- If there might be more results than those appearing in this response, then
nextPageTokenis included. To get the next set of results, call this method again using the value ofnextPageTokenaspageToken. - ListSinksRequest::setParent() — Method in class ListSinksRequest
- Required. The parent resource whose sinks are to be listed: "projects/[PROJECT_ID]" "organizations/[ORGANIZATION_ID]" "billingAccounts/[BILLING_ACCOUNT_ID]" "folders/[FOLDER_ID]"
- ListSinksRequest::setPageToken() — Method in class ListSinksRequest
- Optional. If present, then retrieve the next batch of results from the
preceding call to this method.
pageTokenmust be the value ofnextPageTokenfrom the previous response. The values of other method parameters should be identical to those in the previous call. - ListSinksRequest::setPageSize() — Method in class ListSinksRequest
- Optional. The maximum number of results to return from this request.
- ListSinksResponse::setSinks() — Method in class ListSinksResponse
- A list of sinks.
- ListSinksResponse::setNextPageToken() — Method in class ListSinksResponse
- If there might be more results than appear in this response, then
nextPageTokenis included. To get the next set of results, call the same method again using the value ofnextPageTokenaspageToken. - LogEntry::setLogName() — Method in class LogEntry
- Required. The resource name of the log to which this log entry belongs:
"projects/[PROJECT_ID]/logs/[LOG_ID]"
"organizations/[ORGANIZATION_ID]/logs/[LOG_ID]"
"billingAccounts/[BILLING_ACCOUNT_ID]/logs/[LOG_ID]"
"folders/[FOLDER_ID]/logs/[LOG_ID]"
A project number may optionally be used in place of PROJECT_ID. The
project number is translated to its corresponding PROJECT_ID internally
and the
log_namefield will contain PROJECT_ID in queries and exports. - LogEntry::setResource() — Method in class LogEntry
- Required. The monitored resource associated with this log entry.
- LogEntry::setProtoPayload() — Method in class LogEntry
- The log entry payload, represented as a protocol buffer. Some Google Cloud Platform services use this field for their log entry payloads.
- LogEntry::setTextPayload() — Method in class LogEntry
- The log entry payload, represented as a Unicode string (UTF-8).
- LogEntry::setJsonPayload() — Method in class LogEntry
- The log entry payload, represented as a structure that is expressed as a JSON object.
- LogEntry::setTimestamp() — Method in class LogEntry
- Optional. The time the event described by the log entry occurred.
- LogEntry::setReceiveTimestamp() — Method in class LogEntry
- Output only. The time the log entry was received by Stackdriver Logging.
- LogEntry::setSeverity() — Method in class LogEntry
- Optional. The severity of the log entry. The default value is
LogSeverity.DEFAULT. - LogEntry::setInsertId() — Method in class LogEntry
- Optional. A unique identifier for the log entry. If you provide a value,
then Stackdriver Logging considers other log entries in the same project,
with the same
timestamp, and with the sameinsert_idto be duplicates which can be removed. If omitted in new log entries, then Stackdriver Logging assigns its own unique identifier. Theinsert_idis also used to order log entries that have the sametimestampvalue. - LogEntry::setHttpRequest() — Method in class LogEntry
- Optional. Information about the HTTP request associated with this log entry, if applicable.
- LogEntry::setLabels() — Method in class LogEntry
- Optional. A set of user-defined (key, value) data that provides additional information about the log entry.
- LogEntry::setOperation() — Method in class LogEntry
- Optional. Information about an operation associated with the log entry, if applicable.
- LogEntry::setTrace() — Method in class LogEntry
- Optional. Resource name of the trace associated with the log entry, if any.
- LogEntry::setSpanId() — Method in class LogEntry
- Optional. Id of the span within the trace associated with the log entry.
- LogEntry::setSourceLocation() — Method in class LogEntry
- Optional. Source code location information associated with the log entry, if any.
- LogEntryOperation::setId() — Method in class LogEntryOperation
- Optional. An arbitrary operation identifier. Log entries with the same identifier are assumed to be part of the same operation.
- LogEntryOperation::setProducer() — Method in class LogEntryOperation
- Optional. An arbitrary producer identifier. The combination of
idandproducermust be globally unique. Examples forproducer:"MyDivision.MyBigCompany.com","github.com/MyProject/MyApplication". - LogEntryOperation::setFirst() — Method in class LogEntryOperation
- Optional. Set this to True if this is the first log entry in the operation.
- LogEntryOperation::setLast() — Method in class LogEntryOperation
- Optional. Set this to True if this is the last log entry in the operation.
- LogEntrySourceLocation::setFile() — Method in class LogEntrySourceLocation
- Optional. Source file name. Depending on the runtime environment, this might be a simple name or a fully-qualified name.
- LogEntrySourceLocation::setLine() — Method in class LogEntrySourceLocation
- Optional. Line within the source file. 1-based; 0 indicates no line number available.
- LogEntrySourceLocation::setFunction() — Method in class LogEntrySourceLocation
- Optional. Human-readable name of the function or method being invoked, with
optional context such as the class or package name. This information may be
used in contexts such as the logs viewer, where a file and line number are
less meaningful. The format can vary by language. For example:
qual.if.ied.Class.method(Java),dir/package.func(Go),function(Python). - LogExclusion::setName() — Method in class LogExclusion
- Required. A client-assigned identifier, such as
"load-balancer-exclusion". Identifiers are limited to 100 characters and can include only letters, digits, underscores, hyphens, and periods. - LogExclusion::setDescription() — Method in class LogExclusion
- Optional. A description of this exclusion.
- LogExclusion::setFilter() — Method in class LogExclusion
- Required.
- LogExclusion::setDisabled() — Method in class LogExclusion
- Optional. If set to True, then this exclusion is disabled and it does not exclude any log entries. You can use exclusions.patch to change the value of this field.
- LogMetric::setName() — Method in class LogMetric
- Required. The client-assigned metric identifier.
- LogMetric::setDescription() — Method in class LogMetric
- Optional. A description of this metric, which is used in documentation.
- LogMetric::setFilter() — Method in class LogMetric
- Required. An advanced logs filter which is used to match log entries.
- LogMetric::setMetricDescriptor() — Method in class LogMetric
- Optional. The metric descriptor associated with the logs-based metric.
- LogMetric::setValueExtractor() — Method in class LogMetric
- Optional. A
value_extractoris required when using a distribution logs-based metric to extract the values to record from a log entry. - LogMetric::setLabelExtractors() — Method in class LogMetric
- Optional. A map from a label key string to an extractor expression which is used to extract data from a log entry field and assign as the label value.
- LogMetric::setBucketOptions() — Method in class LogMetric
- Optional. The
bucket_optionsare required when the logs-based metric is using a DISTRIBUTION value type and it describes the bucket boundaries used to create a histogram of the extracted values. - LogMetric::setVersion() — Method in class LogMetric
- Deprecated. The API version that created or updated this metric.
- LogSink::setName() — Method in class LogSink
- Required. The client-assigned sink identifier, unique within the
project. Example:
"my-syslog-errors-to-pubsub". Sink identifiers are limited to 100 characters and can include only the following characters: upper and lower-case alphanumeric characters, underscores, hyphens, and periods. - LogSink::setDestination() — Method in class LogSink
- Required. The export destination:
"storage.googleapis.com/[GCS_BUCKET]"
"bigquery.googleapis.com/projects/[PROJECT_ID]/datasets/[DATASET]"
"pubsub.googleapis.com/projects/[PROJECT_ID]/topics/[TOPIC_ID]"
The sink's
writer_identity, set when the sink is created, must have permission to write to the destination or else the log entries are not exported. For more information, see Exporting Logs With Sinks. - LogSink::setFilter() — Method in class LogSink
- Optional.
- LogSink::setOutputVersionFormat() — Method in class LogSink
- Deprecated. The log entry format to use for this sink's exported log entries. The v2 format is used by default and cannot be changed.
- LogSink::setWriterIdentity() — Method in class LogSink
- Output only. An IAM identity—a service account or group—under
which Stackdriver Logging writes the exported log entries to the sink's
destination. This field is set by
sinks.create
and
sinks.update,
based on the setting of
unique_writer_identityin those methods. - LogSink::setIncludeChildren() — Method in class LogSink
- Optional. This field applies only to sinks owned by organizations and
folders. If the field is false, the default, only the logs owned by the
sink's parent resource are available for export. If the field is true, then
logs from all the projects, folders, and billing accounts contained in the
sink's parent resource are also available for export. Whether a particular
log entry from the children is exported depends on the sink's filter
expression. For example, if this field is true, then the filter
resource.type=gce_instancewould export all Compute Engine VM instance log entries from all projects in the sink's parent. To only export entries from certain child projects, filter on the project part of the log name: logName:("projects/test-project1/" OR "projects/test-project2/") AND resource.type=gce_instance - LogSink::setStartTime() — Method in class LogSink
- Deprecated. This field is ignored when creating or updating sinks.
- LogSink::setEndTime() — Method in class LogSink
- Deprecated. This field is ignored when creating or updating sinks.
- UpdateExclusionRequest::setName() — Method in class UpdateExclusionRequest
- Required. The resource name of the exclusion to update:
"projects/[PROJECT_ID]/exclusions/[EXCLUSION_ID]"
"organizations/[ORGANIZATION_ID]/exclusions/[EXCLUSION_ID]"
"billingAccounts/[BILLING_ACCOUNT_ID]/exclusions/[EXCLUSION_ID]"
"folders/[FOLDER_ID]/exclusions/[EXCLUSION_ID]"
Example:
"projects/my-project-id/exclusions/my-exclusion-id". - UpdateExclusionRequest::setExclusion() — Method in class UpdateExclusionRequest
- Required. New values for the existing exclusion. Only the fields specified
in
update_maskare relevant. - UpdateExclusionRequest::setUpdateMask() — Method in class UpdateExclusionRequest
- Required. A nonempty list of fields to change in the existing exclusion.
- UpdateLogMetricRequest::setMetricName() — Method in class UpdateLogMetricRequest
- The resource name of the metric to update:
"projects/[PROJECT_ID]/metrics/[METRIC_ID]"
The updated metric must be provided in the request and it's
namefield must be the same as[METRIC_ID]If the metric does not exist in[PROJECT_ID], then a new metric is created. - UpdateLogMetricRequest::setMetric() — Method in class UpdateLogMetricRequest
- The updated metric.
- UpdateSinkRequest::setSinkName() — Method in class UpdateSinkRequest
- Required. The full resource name of the sink to update, including the
parent resource and the sink identifier:
"projects/[PROJECT_ID]/sinks/[SINK_ID]"
"organizations/[ORGANIZATION_ID]/sinks/[SINK_ID]"
"billingAccounts/[BILLING_ACCOUNT_ID]/sinks/[SINK_ID]"
"folders/[FOLDER_ID]/sinks/[SINK_ID]"
Example:
"projects/my-project-id/sinks/my-sink-id". - UpdateSinkRequest::setSink() — Method in class UpdateSinkRequest
- Required. The updated sink, whose name is the same identifier that appears
as part of
sink_name. - UpdateSinkRequest::setUniqueWriterIdentity() — Method in class UpdateSinkRequest
- Optional. See
sinks.create
for a description of this field. When updating a sink, the effect of this
field on the value of
writer_identityin the updated sink depends on both the old and new values of this field: + If the old and new values of this field are both false or both true, then there is no change to the sink'swriter_identity. - UpdateSinkRequest::setUpdateMask() — Method in class UpdateSinkRequest
- Optional. Field mask that specifies the fields in
sinkthat need an update. A sink field will be overwritten if, and only if, it is in the update mask.nameand output only fields cannot be updated. - WriteLogEntriesPartialErrors::setLogEntryErrors() — Method in class WriteLogEntriesPartialErrors
- When
WriteLogEntriesRequest.partial_successis true, records the error status for entries that were not written due to a permanent error, keyed by the entry's zero-based index inWriteLogEntriesRequest.entries. - WriteLogEntriesRequest::setLogName() — Method in class WriteLogEntriesRequest
- Optional. A default log resource name that is assigned to all log entries
in
entriesthat do not specify a value forlog_name: "projects/[PROJECT_ID]/logs/[LOG_ID]" "organizations/[ORGANIZATION_ID]/logs/[LOG_ID]" "billingAccounts/[BILLING_ACCOUNT_ID]/logs/[LOG_ID]" "folders/[FOLDER_ID]/logs/[LOG_ID]"[LOG_ID]must be URL-encoded. For example,"projects/my-project-id/logs/syslog"or"organizations/1234567890/logs/cloudresourcemanager.googleapis.com%2Factivity". - WriteLogEntriesRequest::setResource() — Method in class WriteLogEntriesRequest
- Optional. A default monitored resource object that is assigned to all log
entries in
entriesthat do not specify a value forresource. Example: { "type": "gce_instance", "labels": { "zone": "us-central1-a", "instance_id": "00000000000000000000" }} See [LogEntry][google.logging.v2.LogEntry]. - WriteLogEntriesRequest::setLabels() — Method in class WriteLogEntriesRequest
- Optional. Default labels that are added to the
labelsfield of all log entries inentries. If a log entry already has a label with the same key as a label in this parameter, then the log entry's label is not changed. - WriteLogEntriesRequest::setEntries() — Method in class WriteLogEntriesRequest
- Required. The log entries to send to Stackdriver Logging. The order of log
entries in this list does not matter. Values supplied in this method's
log_name,resource, andlabelsfields are copied into those log entries in this list that do not include values for their corresponding fields. For more information, see the [LogEntry][google.logging.v2.LogEntry] type. - WriteLogEntriesRequest::setPartialSuccess() — Method in class WriteLogEntriesRequest
- Optional. Whether valid entries should be written even if some other
entries fail due to INVALID_ARGUMENT or PERMISSION_DENIED errors. If any
entry is not written, then the response status is the error associated
with one of the failed entries and the response includes error details
keyed by the entries' zero-based index in the
entries.writemethod. - Aggregation::setAlignmentPeriod() — Method in class Aggregation
- The alignment period for per-[time series][google.monitoring.v3.TimeSeries]
alignment. If present,
alignmentPeriodmust be at least 60 seconds. After per-time series alignment, each time series will contain data points only on the period boundaries. IfperSeriesAligneris not specified or equalsALIGN_NONE, then this field is ignored. IfperSeriesAligneris specified and does not equalALIGN_NONE, then this field must be defined; otherwise an error is returned. - Aggregation::setPerSeriesAligner() — Method in class Aggregation
- The approach to be used to align individual time series. Not all alignment functions may be applied to all time series, depending on the metric type and value type of the original time series. Alignment may change the metric type or the value type of the time series.
- Aggregation::setCrossSeriesReducer() — Method in class Aggregation
- The approach to be used to combine time series. Not all reducer functions may be applied to all time series, depending on the metric type and the value type of the original time series. Reduction may change the metric type of value type of the time series.
- Aggregation::setGroupByFields() — Method in class Aggregation
- The set of fields to preserve when
crossSeriesReduceris specified. ThegroupByFieldsdetermine how the time series are partitioned into subsets prior to applying the aggregation function. Each subset contains time series that have the same value for each of the grouping fields. Each individual time series is a member of exactly one subset. ThecrossSeriesReduceris applied to each subset of time series. - AlertPolicy::setName() — Method in class AlertPolicy
- Required if the policy exists. The resource name for this policy. The
syntax is:
projects/[PROJECT_ID]/alertPolicies/[ALERT_POLICY_ID]
[ALERT_POLICY_ID]is assigned by Stackdriver Monitoring when the policy is created. When calling the [alertPolicies.create][google.monitoring.v3.AlertPolicyService.CreateAlertPolicy] method, do not include thenamefield in the alerting policy passed as part of the request. - AlertPolicy::setDisplayName() — Method in class AlertPolicy
- A short name or phrase used to identify the policy in dashboards, notifications, and incidents. To avoid confusion, don't use the same display name for multiple policies in the same project. The name is limited to 512 Unicode characters.
- AlertPolicy::setDocumentation() — Method in class AlertPolicy
- Documentation that is included with notifications and incidents related to this policy. Best practice is for the documentation to include information to help responders understand, mitigate, escalate, and correct the underlying problems detected by the alerting policy. Notification channels that have limited capacity might not show this documentation.
- AlertPolicy::setUserLabels() — Method in class AlertPolicy
- User-supplied key/value data to be used for organizing and
identifying the
AlertPolicyobjects. - AlertPolicy::setConditions() — Method in class AlertPolicy
- A list of conditions for the policy. The conditions are combined by AND or
OR according to the
combinerfield. If the combined conditions evaluate to true, then an incident is created. A policy can have from one to six conditions. - AlertPolicy::setCombiner() — Method in class AlertPolicy
- How to combine the results of multiple conditions to determine if an incident should be opened.
- AlertPolicy::setEnabled() — Method in class AlertPolicy
- Whether or not the policy is enabled. On write, the default interpretation if unset is that the policy is enabled. On read, clients should not make any assumption about the state if it has not been populated. The field should always be populated on List and Get operations, unless a field projection has been specified that strips it out.
- AlertPolicy::setNotificationChannels() — Method in class AlertPolicy
- Identifies the notification channels to which notifications should be sent
when incidents are opened or closed or when new violations occur on
an already opened incident. Each element of this array corresponds to
the
namefield in each of the [NotificationChannel][google.monitoring.v3.NotificationChannel] objects that are returned from the [ListNotificationChannels] [google.monitoring.v3.NotificationChannelService.ListNotificationChannels] method. The syntax of the entries in this field is: projects/[PROJECT_ID]/notificationChannels/[CHANNEL_ID] - AlertPolicy::setCreationRecord() — Method in class AlertPolicy
- A read-only record of the creation of the alerting policy. If provided in a call to create or update, this field will be ignored.
- AlertPolicy::setMutationRecord() — Method in class AlertPolicy
- A read-only record of the most recent change to the alerting policy. If provided in a call to create or update, this field will be ignored.
- AlertPolicy_Condition::setName() — Method in class AlertPolicy_Condition
- Required if the condition exists. The unique resource name for this
condition. Its syntax is:
projects/[PROJECT_ID]/alertPolicies/[POLICY_ID]/conditions/[CONDITION_ID]
[CONDITION_ID]is assigned by Stackdriver Monitoring when the condition is created as part of a new or updated alerting policy. - AlertPolicy_Condition::setDisplayName() — Method in class AlertPolicy_Condition
- A short name or phrase used to identify the condition in dashboards, notifications, and incidents. To avoid confusion, don't use the same display name for multiple conditions in the same policy.
- AlertPolicy_Condition::setConditionThreshold() — Method in class AlertPolicy_Condition
- A condition that compares a time series against a threshold.
- AlertPolicy_Condition::setConditionAbsent() — Method in class AlertPolicy_Condition
- A condition that checks that a time series continues to receive new data points.
- AlertPolicy_Condition_MetricAbsence::setFilter() — Method in class AlertPolicy_Condition_MetricAbsence
- A filter that identifies which time series should be compared with the threshold.
- AlertPolicy_Condition_MetricAbsence::setAggregations() — Method in class AlertPolicy_Condition_MetricAbsence
- Specifies the alignment of data points in individual time series as well as how to combine the retrieved time series together (such as when aggregating multiple streams on each resource to a single stream for each resource or when aggregating streams across all members of a group of resrouces). Multiple aggregations are applied in the order specified.
- AlertPolicy_Condition_MetricAbsence::setDuration() — Method in class AlertPolicy_Condition_MetricAbsence
- The amount of time that a time series must fail to report new
data to be considered failing. Currently, only values that
are a multiple of a minute--e.g. 60, 120, or 300
seconds--are supported. If an invalid value is given, an
error will be returned. The
Duration.nanosfield is ignored. - AlertPolicy_Condition_MetricAbsence::setTrigger() — Method in class AlertPolicy_Condition_MetricAbsence
- The number/percent of time series for which the comparison must hold
in order for the condition to trigger. If unspecified, then the
condition will trigger if the comparison is true for any of the
time series that have been identified by
filterandaggregations. - AlertPolicy_Condition_MetricThreshold::setFilter() — Method in class AlertPolicy_Condition_MetricThreshold
- A filter that identifies which time series should be compared with the threshold.
- AlertPolicy_Condition_MetricThreshold::setAggregations() — Method in class AlertPolicy_Condition_MetricThreshold
- Specifies the alignment of data points in individual time series as well as how to combine the retrieved time series together (such as when aggregating multiple streams on each resource to a single stream for each resource or when aggregating streams across all members of a group of resrouces). Multiple aggregations are applied in the order specified.
- AlertPolicy_Condition_MetricThreshold::setDenominatorFilter() — Method in class AlertPolicy_Condition_MetricThreshold
- A filter that identifies a time
series that should be used as the denominator of a ratio that will be
compared with the threshold. If a
denominator_filteris specified, the time series specified by thefilterfield will be used as the numerator. - AlertPolicy_Condition_MetricThreshold::setDenominatorAggregations() — Method in class AlertPolicy_Condition_MetricThreshold
- Specifies the alignment of data points in individual time series
selected by
denominatorFilteras well as how to combine the retrieved time series together (such as when aggregating multiple streams on each resource to a single stream for each resource or when aggregating streams across all members of a group of resources). - AlertPolicy_Condition_MetricThreshold::setComparison() — Method in class AlertPolicy_Condition_MetricThreshold
- The comparison to apply between the time series (indicated by
filterandaggregation) and the threshold (indicated bythreshold_value). - AlertPolicy_Condition_MetricThreshold::setThresholdValue() — Method in class AlertPolicy_Condition_MetricThreshold
- A value against which to compare the time series.
- AlertPolicy_Condition_MetricThreshold::setDuration() — Method in class AlertPolicy_Condition_MetricThreshold
- The amount of time that a time series must violate the
threshold to be considered failing. Currently, only values
that are a multiple of a minute--e.g. 60, 120, or 300
seconds--are supported. If an invalid value is given, an
error will be returned. The
Duration.nanosfield is ignored. When choosing a duration, it is useful to keep in mind the frequency of the underlying time series data (which may also be affected by any alignments specified in theaggregationfield); a good duration is long enough so that a single outlier does not generate spurious alerts, but short enough that unhealthy states are detected and alerted on quickly. - AlertPolicy_Condition_MetricThreshold::setTrigger() — Method in class AlertPolicy_Condition_MetricThreshold
- The number/percent of time series for which the comparison must hold
in order for the condition to trigger. If unspecified, then the
condition will trigger if the comparison is true for any of the
time series that have been identified by
filterandaggregations, or by the ratio, ifdenominator_filteranddenominator_aggregationsare specified. - AlertPolicy_Condition_Trigger::setCount() — Method in class AlertPolicy_Condition_Trigger
- The absolute number of time series that must fail the predicate for the condition to be triggered.
- AlertPolicy_Condition_Trigger::setPercent() — Method in class AlertPolicy_Condition_Trigger
- The percentage of time series that must fail the predicate for the condition to be triggered.
- AlertPolicy_Documentation::setContent() — Method in class AlertPolicy_Documentation
- The text of the documentation, interpreted according to
mime_type. - AlertPolicy_Documentation::setMimeType() — Method in class AlertPolicy_Documentation
- The format of the
contentfield. Presently, only the value"text/markdown"is supported. See Markdown for more information. - CreateAlertPolicyRequest::setName() — Method in class CreateAlertPolicyRequest
- The project in which to create the alerting policy. The format is
projects/[PROJECT_ID]. - CreateAlertPolicyRequest::setAlertPolicy() — Method in class CreateAlertPolicyRequest
- The requested alerting policy. You should omit the
namefield in this policy. The name will be returned in the new policy, including a new [ALERT_POLICY_ID] value. - CreateGroupRequest::setName() — Method in class CreateGroupRequest
- The project in which to create the group. The format is
"projects/{project_id_or_number}". - CreateGroupRequest::setGroup() — Method in class CreateGroupRequest
- A group definition. It is an error to define the
namefield because the system assigns the name. - CreateGroupRequest::setValidateOnly() — Method in class CreateGroupRequest
- If true, validate this request but do not create the group.
- CreateMetricDescriptorRequest::setName() — Method in class CreateMetricDescriptorRequest
- The project on which to execute the request. The format is
"projects/{project_id_or_number}". - CreateMetricDescriptorRequest::setMetricDescriptor() — Method in class CreateMetricDescriptorRequest
- The new custom metric descriptor.
- CreateNotificationChannelRequest::setName() — Method in class CreateNotificationChannelRequest
- The project on which to execute the request. The format is:
projects/[PROJECT_ID]
Note that this names the container into which the channel will be
written. This does not name the newly created channel. The resulting
channel's name will have a normalized version of this field as a prefix,
but will add
/notificationChannels/[CHANNEL_ID]to identify the channel. - CreateNotificationChannelRequest::setNotificationChannel() — Method in class CreateNotificationChannelRequest
- The definition of the
NotificationChannelto create. - CreateTimeSeriesError::setTimeSeries() — Method in class CreateTimeSeriesError
- The time series, including the
Metric,MonitoredResource, andPoints (including timestamp and value) that resulted in the error. This field provides all of the context that would be needed to retry the operation. - CreateTimeSeriesError::setStatus() — Method in class CreateTimeSeriesError
- The status of the requested write operation.
- CreateTimeSeriesRequest::setName() — Method in class CreateTimeSeriesRequest
- The project on which to execute the request. The format is
"projects/{project_id_or_number}". - CreateTimeSeriesRequest::setTimeSeries() — Method in class CreateTimeSeriesRequest
- The new data to be added to a list of time series.
- CreateUptimeCheckConfigRequest::setParent() — Method in class CreateUptimeCheckConfigRequest
- The project in which to create the uptime check. The format is:
projects/[PROJECT_ID]. - CreateUptimeCheckConfigRequest::setUptimeCheckConfig() — Method in class CreateUptimeCheckConfigRequest
- The new uptime check configuration.
- DeleteAlertPolicyRequest::setName() — Method in class DeleteAlertPolicyRequest
- The alerting policy to delete. The format is: projects/[PROJECT_ID]/alertPolicies/[ALERT_POLICY_ID] For more information, see [AlertPolicy][google.monitoring.v3.AlertPolicy].
- DeleteGroupRequest::setName() — Method in class DeleteGroupRequest
- The group to delete. The format is
"projects/{project_id_or_number}/groups/{group_id}". - DeleteMetricDescriptorRequest::setName() — Method in class DeleteMetricDescriptorRequest
- The metric descriptor on which to execute the request. The format is
"projects/{project_id_or_number}/metricDescriptors/{metric_id}". - DeleteNotificationChannelRequest::setName() — Method in class DeleteNotificationChannelRequest
- The channel for which to execute the request. The format is
projects/[PROJECT_ID]/notificationChannels/[CHANNEL_ID]. - DeleteNotificationChannelRequest::setForce() — Method in class DeleteNotificationChannelRequest
- If true, the notification channel will be deleted regardless of its use in alert policies (the policies will be updated to remove the channel). If false, channels that are still referenced by an existing alerting policy will fail to be deleted in a delete operation.
- DeleteUptimeCheckConfigRequest::setName() — Method in class DeleteUptimeCheckConfigRequest
- The uptime check configuration to delete. The format is
projects/[PROJECT_ID]/uptimeCheckConfigs/[UPTIME_CHECK_ID]. - GetAlertPolicyRequest::setName() — Method in class GetAlertPolicyRequest
- The alerting policy to retrieve. The format is projects/[PROJECT_ID]/alertPolicies/[ALERT_POLICY_ID]
- GetGroupRequest::setName() — Method in class GetGroupRequest
- The group to retrieve. The format is
"projects/{project_id_or_number}/groups/{group_id}". - GetMetricDescriptorRequest::setName() — Method in class GetMetricDescriptorRequest
- The metric descriptor on which to execute the request. The format is
"projects/{project_id_or_number}/metricDescriptors/{metric_id}". - GetMonitoredResourceDescriptorRequest::setName() — Method in class GetMonitoredResourceDescriptorRequest
- The monitored resource descriptor to get. The format is
"projects/{project_id_or_number}/monitoredResourceDescriptors/{resource_type}". - GetNotificationChannelDescriptorRequest::setName() — Method in class GetNotificationChannelDescriptorRequest
- The channel type for which to execute the request. The format is
projects/[PROJECT_ID]/notificationChannelDescriptors/{channel_type}. - GetNotificationChannelRequest::setName() — Method in class GetNotificationChannelRequest
- The channel for which to execute the request. The format is
projects/[PROJECT_ID]/notificationChannels/[CHANNEL_ID]. - GetNotificationChannelVerificationCodeRequest::setName() — Method in class GetNotificationChannelVerificationCodeRequest
- The notification channel for which a verification code is to be generated and retrieved. This must name a channel that is already verified; if the specified channel is not verified, the request will fail.
- GetNotificationChannelVerificationCodeRequest::setExpireTime() — Method in class GetNotificationChannelVerificationCodeRequest
- The desired expiration time. If specified, the API will guarantee that the returned code will not be valid after the specified timestamp; however, the API cannot guarantee that the returned code will be valid for at least as long as the requested time (the API puts an upper bound on the amount of time for which a code may be valid). If omitted, a default expiration will be used, which may be less than the max permissible expiration (so specifying an expiration may extend the code's lifetime over omitting an expiration, even though the API does impose an upper limit on the maximum expiration that is permitted).
- GetNotificationChannelVerificationCodeResponse::setCode() — Method in class GetNotificationChannelVerificationCodeResponse
- The verification code, which may be used to verify other channels that have an equivalent identity (i.e. other channels of the same type with the same fingerprint such as other email channels with the same email address or other sms channels with the same number).
- GetNotificationChannelVerificationCodeResponse::setExpireTime() — Method in class GetNotificationChannelVerificationCodeResponse
- The expiration time associated with the code that was returned. If an expiration was provided in the request, this is the minimum of the requested expiration in the request and the max permitted expiration.
- GetUptimeCheckConfigRequest::setName() — Method in class GetUptimeCheckConfigRequest
- The uptime check configuration to retrieve. The format is
projects/[PROJECT_ID]/uptimeCheckConfigs/[UPTIME_CHECK_ID]. - Group::setName() — Method in class Group
- Output only. The name of this group. The format is
"projects/{project_id_or_number}/groups/{group_id}". - Group::setDisplayName() — Method in class Group
- A user-assigned name for this group, used only for display purposes.
- Group::setParentName() — Method in class Group
- The name of the group's parent, if it has one.
- Group::setFilter() — Method in class Group
- The filter used to determine which monitored resources belong to this group.
- Group::setIsCluster() — Method in class Group
- If true, the members of this group are considered to be a cluster.
- ListAlertPoliciesRequest::setName() — Method in class ListAlertPoliciesRequest
- The project whose alert policies are to be listed. The format is projects/[PROJECT_ID] Note that this field names the parent container in which the alerting policies to be listed are stored. To retrieve a single alerting policy by name, use the [GetAlertPolicy][google.monitoring.v3.AlertPolicyService.GetAlertPolicy] operation, instead.
- ListAlertPoliciesRequest::setFilter() — Method in class ListAlertPoliciesRequest
- If provided, this field specifies the criteria that must be met by alert policies to be included in the response.
- ListAlertPoliciesRequest::setOrderBy() — Method in class ListAlertPoliciesRequest
- A comma-separated list of fields by which to sort the result. Supports
the same set of field references as the
filterfield. Entries can be prefixed with a minus sign to sort by the field in descending order. - ListAlertPoliciesRequest::setPageSize() — Method in class ListAlertPoliciesRequest
- The maximum number of results to return in a single response.
- ListAlertPoliciesRequest::setPageToken() — Method in class ListAlertPoliciesRequest
- If this field is not empty then it must contain the
nextPageTokenvalue returned by a previous call to this method. Using this field causes the method to return more results from the previous method call. - ListAlertPoliciesResponse::setAlertPolicies() — Method in class ListAlertPoliciesResponse
- The returned alert policies.
- ListAlertPoliciesResponse::setNextPageToken() — Method in class ListAlertPoliciesResponse
- If there might be more results than were returned, then this field is set
to a non-empty value. To see the additional results,
use that value as
pageTokenin the next call to this method. - ListGroupMembersRequest::setName() — Method in class ListGroupMembersRequest
- The group whose members are listed. The format is
"projects/{project_id_or_number}/groups/{group_id}". - ListGroupMembersRequest::setPageSize() — Method in class ListGroupMembersRequest
- A positive number that is the maximum number of results to return.
- ListGroupMembersRequest::setPageToken() — Method in class ListGroupMembersRequest
- If this field is not empty then it must contain the
nextPageTokenvalue returned by a previous call to this method. Using this field causes the method to return additional results from the previous method call. - ListGroupMembersRequest::setFilter() — Method in class ListGroupMembersRequest
- An optional list filter describing the members to be returned. The filter may reference the type, labels, and metadata of monitored resources that comprise the group.
- ListGroupMembersRequest::setInterval() — Method in class ListGroupMembersRequest
- An optional time interval for which results should be returned. Only members that were part of the group during the specified interval are included in the response. If no interval is provided then the group membership over the last minute is returned.
- ListGroupMembersResponse::setMembers() — Method in class ListGroupMembersResponse
- A set of monitored resources in the group.
- ListGroupMembersResponse::setNextPageToken() — Method in class ListGroupMembersResponse
- If there are more results than have been returned, then this field is
set to a non-empty value. To see the additional results, use that value as
pageTokenin the next call to this method. - ListGroupMembersResponse::setTotalSize() — Method in class ListGroupMembersResponse
- The total number of elements matching this request.
- ListGroupsRequest::setName() — Method in class ListGroupsRequest
- The project whose groups are to be listed. The format is
"projects/{project_id_or_number}". - ListGroupsRequest::setChildrenOfGroup() — Method in class ListGroupsRequest
- A group name:
"projects/{project_id_or_number}/groups/{group_id}". - ListGroupsRequest::setAncestorsOfGroup() — Method in class ListGroupsRequest
- A group name:
"projects/{project_id_or_number}/groups/{group_id}". - ListGroupsRequest::setDescendantsOfGroup() — Method in class ListGroupsRequest
- A group name:
"projects/{project_id_or_number}/groups/{group_id}". - ListGroupsRequest::setPageSize() — Method in class ListGroupsRequest
- A positive number that is the maximum number of results to return.
- ListGroupsRequest::setPageToken() — Method in class ListGroupsRequest
- If this field is not empty then it must contain the
nextPageTokenvalue returned by a previous call to this method. Using this field causes the method to return additional results from the previous method call. - ListGroupsResponse::setGroup() — Method in class ListGroupsResponse
- The groups that match the specified filters.
- ListGroupsResponse::setNextPageToken() — Method in class ListGroupsResponse
- If there are more results than have been returned, then this field is set
to a non-empty value. To see the additional results,
use that value as
pageTokenin the next call to this method. - ListMetricDescriptorsRequest::setName() — Method in class ListMetricDescriptorsRequest
- The project on which to execute the request. The format is
"projects/{project_id_or_number}". - ListMetricDescriptorsRequest::setFilter() — Method in class ListMetricDescriptorsRequest
- If this field is empty, all custom and system-defined metric descriptors are returned.
- ListMetricDescriptorsRequest::setPageSize() — Method in class ListMetricDescriptorsRequest
- A positive number that is the maximum number of results to return.
- ListMetricDescriptorsRequest::setPageToken() — Method in class ListMetricDescriptorsRequest
- If this field is not empty then it must contain the
nextPageTokenvalue returned by a previous call to this method. Using this field causes the method to return additional results from the previous method call. - ListMetricDescriptorsResponse::setMetricDescriptors() — Method in class ListMetricDescriptorsResponse
- The metric descriptors that are available to the project
and that match the value of
filter, if present. - ListMetricDescriptorsResponse::setNextPageToken() — Method in class ListMetricDescriptorsResponse
- If there are more results than have been returned, then this field is set
to a non-empty value. To see the additional results,
use that value as
pageTokenin the next call to this method. - ListMonitoredResourceDescriptorsRequest::setName() — Method in class ListMonitoredResourceDescriptorsRequest
- The project on which to execute the request. The format is
"projects/{project_id_or_number}". - ListMonitoredResourceDescriptorsRequest::setFilter() — Method in class ListMonitoredResourceDescriptorsRequest
- An optional filter describing
the descriptors to be returned. The filter can reference
the descriptor's type and labels. For example, the
following filter returns only Google Compute Engine descriptors
that have an
idlabel: resource.type = starts_with("gce_") AND resource.label:id - ListMonitoredResourceDescriptorsRequest::setPageSize() — Method in class ListMonitoredResourceDescriptorsRequest
- A positive number that is the maximum number of results to return.
- ListMonitoredResourceDescriptorsRequest::setPageToken() — Method in class ListMonitoredResourceDescriptorsRequest
- If this field is not empty then it must contain the
nextPageTokenvalue returned by a previous call to this method. Using this field causes the method to return additional results from the previous method call. - ListMonitoredResourceDescriptorsResponse::setResourceDescriptors() — Method in class ListMonitoredResourceDescriptorsResponse
- The monitored resource descriptors that are available to this project
and that match
filter, if present. - ListMonitoredResourceDescriptorsResponse::setNextPageToken() — Method in class ListMonitoredResourceDescriptorsResponse
- If there are more results than have been returned, then this field is set
to a non-empty value. To see the additional results,
use that value as
pageTokenin the next call to this method. - ListNotificationChannelDescriptorsRequest::setName() — Method in class ListNotificationChannelDescriptorsRequest
- The REST resource name of the parent from which to retrieve the notification channel descriptors. The expected syntax is: projects/[PROJECT_ID] Note that this names the parent container in which to look for the descriptors; to retrieve a single descriptor by name, use the [GetNotificationChannelDescriptor][google.monitoring.v3.NotificationChannelService.GetNotificationChannelDescriptor] operation, instead.
- ListNotificationChannelDescriptorsRequest::setPageSize() — Method in class ListNotificationChannelDescriptorsRequest
- The maximum number of results to return in a single response. If not set to a positive number, a reasonable value will be chosen by the service.
- ListNotificationChannelDescriptorsRequest::setPageToken() — Method in class ListNotificationChannelDescriptorsRequest
- If non-empty,
page_tokenmust contain a value returned as thenext_page_tokenin a previous response to request the next set of results. - ListNotificationChannelDescriptorsResponse::setChannelDescriptors() — Method in class ListNotificationChannelDescriptorsResponse
- The monitored resource descriptors supported for the specified project, optionally filtered.
- ListNotificationChannelDescriptorsResponse::setNextPageToken() — Method in class ListNotificationChannelDescriptorsResponse
- If not empty, indicates that there may be more results that match
the request. Use the value in the
page_tokenfield in a subsequent request to fetch the next set of results. If empty, all results have been returned. - ListNotificationChannelsRequest::setName() — Method in class ListNotificationChannelsRequest
- The project on which to execute the request. The format is
projects/[PROJECT_ID]. That is, this names the container in which to look for the notification channels; it does not name a specific channel. To query a specific channel by REST resource name, use the [GetNotificationChannel][google.monitoring.v3.NotificationChannelService.GetNotificationChannel] operation. - ListNotificationChannelsRequest::setFilter() — Method in class ListNotificationChannelsRequest
- If provided, this field specifies the criteria that must be met by notification channels to be included in the response.
- ListNotificationChannelsRequest::setOrderBy() — Method in class ListNotificationChannelsRequest
- A comma-separated list of fields by which to sort the result. Supports
the same set of fields as in
filter. Entries can be prefixed with a minus sign to sort in descending rather than ascending order. - ListNotificationChannelsRequest::setPageSize() — Method in class ListNotificationChannelsRequest
- The maximum number of results to return in a single response. If not set to a positive number, a reasonable value will be chosen by the service.
- ListNotificationChannelsRequest::setPageToken() — Method in class ListNotificationChannelsRequest
- If non-empty,
page_tokenmust contain a value returned as thenext_page_tokenin a previous response to request the next set of results. - ListNotificationChannelsResponse::setNotificationChannels() — Method in class ListNotificationChannelsResponse
- The notification channels defined for the specified project.
- ListNotificationChannelsResponse::setNextPageToken() — Method in class ListNotificationChannelsResponse
- If not empty, indicates that there may be more results that match
the request. Use the value in the
page_tokenfield in a subsequent request to fetch the next set of results. If empty, all results have been returned. - ListTimeSeriesRequest::setName() — Method in class ListTimeSeriesRequest
- The project on which to execute the request. The format is "projects/{project_id_or_number}".
- ListTimeSeriesRequest::setFilter() — Method in class ListTimeSeriesRequest
- A monitoring filter that specifies which time series should be returned. The filter must specify a single metric type, and can additionally specify metric labels and other information. For example: metric.type = "compute.googleapis.com/instance/cpu/usage_time" AND metric.label.instance_name = "my-instance-name"
- ListTimeSeriesRequest::setInterval() — Method in class ListTimeSeriesRequest
- The time interval for which results should be returned. Only time series that contain data points in the specified interval are included in the response.
- ListTimeSeriesRequest::setAggregation() — Method in class ListTimeSeriesRequest
- By default, the raw time series data is returned.
- ListTimeSeriesRequest::setOrderBy() — Method in class ListTimeSeriesRequest
- Specifies the order in which the points of the time series should be returned. By default, results are not ordered. Currently, this field must be left blank.
- ListTimeSeriesRequest::setView() — Method in class ListTimeSeriesRequest
- Specifies which information is returned about the time series.
- ListTimeSeriesRequest::setPageSize() — Method in class ListTimeSeriesRequest
- A positive number that is the maximum number of results to return.
- ListTimeSeriesRequest::setPageToken() — Method in class ListTimeSeriesRequest
- If this field is not empty then it must contain the
nextPageTokenvalue returned by a previous call to this method. Using this field causes the method to return additional results from the previous method call. - ListTimeSeriesResponse::setTimeSeries() — Method in class ListTimeSeriesResponse
- One or more time series that match the filter included in the request.
- ListTimeSeriesResponse::setNextPageToken() — Method in class ListTimeSeriesResponse
- If there are more results than have been returned, then this field is set
to a non-empty value. To see the additional results,
use that value as
pageTokenin the next call to this method. - ListUptimeCheckConfigsRequest::setParent() — Method in class ListUptimeCheckConfigsRequest
- The project whose uptime check configurations are listed. The format is
projects/[PROJECT_ID]. - ListUptimeCheckConfigsRequest::setPageSize() — Method in class ListUptimeCheckConfigsRequest
- The maximum number of results to return in a single response. The server may further constrain the maximum number of results returned in a single page. If the page_size is <=0, the server will decide the number of results to be returned.
- ListUptimeCheckConfigsRequest::setPageToken() — Method in class ListUptimeCheckConfigsRequest
- If this field is not empty then it must contain the
nextPageTokenvalue returned by a previous call to this method. Using this field causes the method to return more results from the previous method call. - ListUptimeCheckConfigsResponse::setUptimeCheckConfigs() — Method in class ListUptimeCheckConfigsResponse
- The returned uptime check configurations.
- ListUptimeCheckConfigsResponse::setNextPageToken() — Method in class ListUptimeCheckConfigsResponse
- This field represents the pagination token to retrieve the next page of results. If the value is empty, it means no further results for the request. To retrieve the next page of results, the value of the next_page_token is passed to the subsequent List method call (in the request message's page_token field).
- ListUptimeCheckIpsRequest::setPageSize() — Method in class ListUptimeCheckIpsRequest
- The maximum number of results to return in a single response. The server may further constrain the maximum number of results returned in a single page. If the page_size is <=0, the server will decide the number of results to be returned.
- ListUptimeCheckIpsRequest::setPageToken() — Method in class ListUptimeCheckIpsRequest
- If this field is not empty then it must contain the
nextPageTokenvalue returned by a previous call to this method. Using this field causes the method to return more results from the previous method call. - ListUptimeCheckIpsResponse::setUptimeCheckIps() — Method in class ListUptimeCheckIpsResponse
- The returned list of IP addresses (including region and location) that the checkers run from.
- ListUptimeCheckIpsResponse::setNextPageToken() — Method in class ListUptimeCheckIpsResponse
- This field represents the pagination token to retrieve the next page of results. If the value is empty, it means no further results for the request. To retrieve the next page of results, the value of the next_page_token is passed to the subsequent List method call (in the request message's page_token field).
- MutationRecord::setMutateTime() — Method in class MutationRecord
- When the change occurred.
- MutationRecord::setMutatedBy() — Method in class MutationRecord
- The email address of the user making the change.
- NotificationChannel::setType() — Method in class NotificationChannel
- The type of the notification channel. This field matches the value of the [NotificationChannelDescriptor.type][google.monitoring.v3.NotificationChannelDescriptor.type] field.
- NotificationChannel::setName() — Method in class NotificationChannel
- The full REST resource name for this channel. The syntax is:
projects/[PROJECT_ID]/notificationChannels/[CHANNEL_ID]
The
[CHANNEL_ID]is automatically assigned by the server on creation. - NotificationChannel::setDisplayName() — Method in class NotificationChannel
- An optional human-readable name for this notification channel. It is recommended that you specify a non-empty and unique name in order to make it easier to identify the channels in your project, though this is not enforced. The display name is limited to 512 Unicode characters.
- NotificationChannel::setDescription() — Method in class NotificationChannel
- An optional human-readable description of this notification channel. This description may provide additional details, beyond the display name, for the channel. This may not exceeed 1024 Unicode characters.
- NotificationChannel::setLabels() — Method in class NotificationChannel
- Configuration fields that define the channel and its behavior. The
permissible and required labels are specified in the
[NotificationChannelDescriptor.labels][google.monitoring.v3.NotificationChannelDescriptor.labels] of the
NotificationChannelDescriptorcorresponding to thetypefield. - NotificationChannel::setUserLabels() — Method in class NotificationChannel
- User-supplied key/value data that does not need to conform to
the corresponding
NotificationChannelDescriptor's schema, unlike thelabelsfield. This field is intended to be used for organizing and identifying theNotificationChannelobjects. - NotificationChannel::setVerificationStatus() — Method in class NotificationChannel
- Indicates whether this channel has been verified or not. On a
[
ListNotificationChannels][google.monitoring.v3.NotificationChannelService.ListNotificationChannels] or [GetNotificationChannel][google.monitoring.v3.NotificationChannelService.GetNotificationChannel] operation, this field is expected to be populated. - NotificationChannel::setEnabled() — Method in class NotificationChannel
- Whether notifications are forwarded to the described channel. This makes it possible to disable delivery of notifications to a particular channel without removing the channel from all alerting policies that reference the channel. This is a more convenient approach when the change is temporary and you want to receive notifications from the same set of alerting policies on the channel at some point in the future.
- NotificationChannelDescriptor::setName() — Method in class NotificationChannelDescriptor
- The full REST resource name for this descriptor. The syntax is:
projects/[PROJECT_ID]/notificationChannelDescriptors/[TYPE]
In the above,
[TYPE]is the value of thetypefield. - NotificationChannelDescriptor::setType() — Method in class NotificationChannelDescriptor
- The type of notification channel, such as "email", "sms", etc.
- NotificationChannelDescriptor::setDisplayName() — Method in class NotificationChannelDescriptor
- A human-readable name for the notification channel type. This form of the name is suitable for a user interface.
- NotificationChannelDescriptor::setDescription() — Method in class NotificationChannelDescriptor
- A human-readable description of the notification channel type. The description may include a description of the properties of the channel and pointers to external documentation.
- NotificationChannelDescriptor::setLabels() — Method in class NotificationChannelDescriptor
- The set of labels that must be defined to identify a particular channel of the corresponding type. Each label includes a description for how that field should be populated.
- NotificationChannelDescriptor::setSupportedTiers() — Method in class NotificationChannelDescriptor
- The tiers that support this notification channel; the project service tier must be one of the supported_tiers.
- NotificationChannelServiceGrpcClient::SendNotificationChannelVerificationCode() — Method in class NotificationChannelServiceGrpcClient
- Causes a verification code to be delivered to the channel. The code
can then be supplied in
VerifyNotificationChannelto verify the channel. - Point::setInterval() — Method in class Point
- The time interval to which the data point applies. For GAUGE metrics, only the end time of the interval is used. For DELTA metrics, the start and end time should specify a non-zero interval, with subsequent points specifying contiguous and non-overlapping intervals. For CUMULATIVE metrics, the start and end time should specify a non-zero interval, with subsequent points specifying the same start time and increasing end times, until an event resets the cumulative value to zero and sets a new start time for the following points.
- Point::setValue() — Method in class Point
- The value of the data point.
- SendNotificationChannelVerificationCodeRequest — Class in namespace Google\Cloud\Monitoring\V3
- The
SendNotificationChannelVerificationCoderequest. - SendNotificationChannelVerificationCodeRequest::setName() — Method in class SendNotificationChannelVerificationCodeRequest
- The notification channel to which to send a verification code.
- ServiceTier — Class in namespace Google\Cloud\Monitoring\V3
- The tier of service for a Stackdriver account. Please see the service tiers documentation for more details.
- TimeInterval::setEndTime() — Method in class TimeInterval
- Required. The end of the time interval.
- TimeInterval::setStartTime() — Method in class TimeInterval
- Optional. The beginning of the time interval. The default value for the start time is the end time. The start time must not be later than the end time.
- TimeSeries::setMetric() — Method in class TimeSeries
- The associated metric. A fully-specified metric used to identify the time series.
- TimeSeries::setResource() — Method in class TimeSeries
- The associated resource. A fully-specified monitored resource used to identify the time series.
- TimeSeries::setMetricKind() — Method in class TimeSeries
- The metric kind of the time series. When listing time series, this metric kind might be different from the metric kind of the associated metric if this time series is an alignment or reduction of other time series.
- TimeSeries::setValueType() — Method in class TimeSeries
- The value type of the time series. When listing time series, this value type might be different from the value type of the associated metric if this time series is an alignment or reduction of other time series.
- TimeSeries::setPoints() — Method in class TimeSeries
- The data points of this time series. When listing time series, the order of the points is specified by the list method.
- TypedValue::setBoolValue() — Method in class TypedValue
- A Boolean value:
trueorfalse. - TypedValue::setInt64Value() — Method in class TypedValue
- A 64-bit integer. Its range is approximately ±9.2x1018.
- TypedValue::setDoubleValue() — Method in class TypedValue
- A 64-bit double-precision floating-point number. Its magnitude is approximately ±10±300 and it has 16 significant digits of precision.
- TypedValue::setStringValue() — Method in class TypedValue
- A variable-length string value.
- TypedValue::setDistributionValue() — Method in class TypedValue
- A distribution value.
- UpdateAlertPolicyRequest::setUpdateMask() — Method in class UpdateAlertPolicyRequest
- Optional. A list of alerting policy field names. If this field is not
empty, each listed field in the existing alerting policy is set to the
value of the corresponding field in the supplied policy (
alert_policy), or to the field's default value if the field is not in the supplied alerting policy. Fields not listed retain their previous value. - UpdateAlertPolicyRequest::setAlertPolicy() — Method in class UpdateAlertPolicyRequest
- Required. The updated alerting policy or the updated values for the
fields listed in
update_mask. - UpdateGroupRequest::setGroup() — Method in class UpdateGroupRequest
- The new definition of the group. All fields of the existing group,
excepting
name, are replaced with the corresponding fields of this group. - UpdateGroupRequest::setValidateOnly() — Method in class UpdateGroupRequest
- If true, validate this request but do not update the existing group.
- UpdateNotificationChannelRequest::setUpdateMask() — Method in class UpdateNotificationChannelRequest
- The fields to update.
- UpdateNotificationChannelRequest::setNotificationChannel() — Method in class UpdateNotificationChannelRequest
- A description of the changes to be applied to the specified
notification channel. The description must provide a definition for
fields to be updated; the names of these fields should also be
included in the
update_mask. - UpdateUptimeCheckConfigRequest::setUpdateMask() — Method in class UpdateUptimeCheckConfigRequest
- Optional. If present, only the listed fields in the current uptime check configuration are updated with values from the new configuration. If this field is empty, then the current configuration is completely replaced with the new configuration.
- UpdateUptimeCheckConfigRequest::setUptimeCheckConfig() — Method in class UpdateUptimeCheckConfigRequest
- Required. If an
"updateMask"has been specified, this field gives the values for the set of fields mentioned in the"updateMask". If an"updateMask"has not been given, this uptime check configuration replaces the current configuration. If a field is mentioned in"updateMask" but the corresonding field is omitted in this partial uptime check configuration, it has the effect of deleting/clearing the field from the configuration on the server. - UptimeCheckConfig::setName() — Method in class UptimeCheckConfig
- A unique resource name for this UptimeCheckConfig. The format is:
projects/[PROJECT_ID]/uptimeCheckConfigs/[UPTIME_CHECK_ID]. - UptimeCheckConfig::setDisplayName() — Method in class UptimeCheckConfig
- A human-friendly name for the uptime check configuration. The display name should be unique within a Stackdriver Account in order to make it easier to identify; however, uniqueness is not enforced. Required.
- UptimeCheckConfig::setMonitoredResource() — Method in class UptimeCheckConfig
- The monitored resource associated with the configuration.
- UptimeCheckConfig::setResourceGroup() — Method in class UptimeCheckConfig
- The group resource associated with the configuration.
- UptimeCheckConfig::setHttpCheck() — Method in class UptimeCheckConfig
- Contains information needed to make an HTTP or HTTPS check.
- UptimeCheckConfig::setTcpCheck() — Method in class UptimeCheckConfig
- Contains information needed to make a TCP check.
- UptimeCheckConfig::setPeriod() — Method in class UptimeCheckConfig
- How often the uptime check is performed.
- UptimeCheckConfig::setTimeout() — Method in class UptimeCheckConfig
- The maximum amount of time to wait for the request to complete (must be between 1 and 60 seconds). Required.
- UptimeCheckConfig::setContentMatchers() — Method in class UptimeCheckConfig
- The expected content on the page the check is run against.
- UptimeCheckConfig::setSelectedRegions() — Method in class UptimeCheckConfig
- The list of regions from which the check will be run.
- UptimeCheckConfig::setInternalCheckers() — Method in class UptimeCheckConfig
- The internal checkers that this check will egress from.
- UptimeCheckConfig_ContentMatcher::setContent() — Method in class UptimeCheckConfig_ContentMatcher
- String content to match
- UptimeCheckConfig_HttpCheck::setUseSsl() — Method in class UptimeCheckConfig_HttpCheck
- If true, use HTTPS instead of HTTP to run the check.
- UptimeCheckConfig_HttpCheck::setPath() — Method in class UptimeCheckConfig_HttpCheck
- The path to the page to run the check against. Will be combined with the host (specified within the MonitoredResource) and port to construct the full URL. Optional (defaults to "/").
- UptimeCheckConfig_HttpCheck::setPort() — Method in class UptimeCheckConfig_HttpCheck
- The port to the page to run the check against. Will be combined with host (specified within the MonitoredResource) and path to construct the full URL. Optional (defaults to 80 without SSL, or 443 with SSL).
- UptimeCheckConfig_HttpCheck::setAuthInfo() — Method in class UptimeCheckConfig_HttpCheck
- The authentication information. Optional when creating an HTTP check; defaults to empty.
- UptimeCheckConfig_HttpCheck::setMaskHeaders() — Method in class UptimeCheckConfig_HttpCheck
- Boolean specifiying whether to encrypt the header information.
- UptimeCheckConfig_HttpCheck::setHeaders() — Method in class UptimeCheckConfig_HttpCheck
- The list of headers to send as part of the uptime check request.
- UptimeCheckConfig_HttpCheck_BasicAuthentication::setUsername() — Method in class UptimeCheckConfig_HttpCheck_BasicAuthentication
- The username to authenticate.
- UptimeCheckConfig_HttpCheck_BasicAuthentication::setPassword() — Method in class UptimeCheckConfig_HttpCheck_BasicAuthentication
- The password to authenticate.
- UptimeCheckConfig_InternalChecker::setProjectId() — Method in class UptimeCheckConfig_InternalChecker
- The GCP project ID. Not necessarily the same as the project_id for the config.
- UptimeCheckConfig_InternalChecker::setNetwork() — Method in class UptimeCheckConfig_InternalChecker
- The internal network to perform this uptime check on.
- UptimeCheckConfig_InternalChecker::setGcpZone() — Method in class UptimeCheckConfig_InternalChecker
- The GCP zone the uptime check should egress from. Only respected for internal uptime checks, where internal_network is specified.
- UptimeCheckConfig_InternalChecker::setCheckerId() — Method in class UptimeCheckConfig_InternalChecker
- The checker ID.
- UptimeCheckConfig_InternalChecker::setDisplayName() — Method in class UptimeCheckConfig_InternalChecker
- The checker's human-readable name.
- UptimeCheckConfig_ResourceGroup::setGroupId() — Method in class UptimeCheckConfig_ResourceGroup
- The group of resources being monitored. Should be only the
group_id, not projects/
/groups/ . - UptimeCheckConfig_ResourceGroup::setResourceType() — Method in class UptimeCheckConfig_ResourceGroup
- The resource type of the group members.
- UptimeCheckConfig_TcpCheck::setPort() — Method in class UptimeCheckConfig_TcpCheck
- The port to the page to run the check against. Will be combined with host (specified within the MonitoredResource) to construct the full URL.
- UptimeCheckIp::setRegion() — Method in class UptimeCheckIp
- A broad region category in which the IP address is located.
- UptimeCheckIp::setLocation() — Method in class UptimeCheckIp
- A more specific location within the region that typically encodes a particular city/town/metro (and its containing state/province or country) within the broader umbrella region category.
- UptimeCheckIp::setIpAddress() — Method in class UptimeCheckIp
- The IP address from which the uptime check originates. This is a full IP address (not an IP address range). Most IP addresses, as of this publication, are in IPv4 format; however, one should not rely on the IP addresses being in IPv4 format indefinitely and should support interpreting this field in either IPv4 or IPv6 format.
- VerifyNotificationChannelRequest::setName() — Method in class VerifyNotificationChannelRequest
- The notification channel to verify.
- VerifyNotificationChannelRequest::setCode() — Method in class VerifyNotificationChannelRequest
- The verification code that was delivered to the channel as
a result of invoking the
SendNotificationChannelVerificationCodeAPI method or that was retrieved from a verified channel viaGetNotificationChannelVerificationCode. For example, one might have "G-123456" or "TKNZGhhd2EyN3I1MnRnMjRv" (in general, one is only guaranteed that the code is valid UTF-8; one should not make any assumptions regarding the structure or format of the code). - PosixAccount::setPrimary() — Method in class PosixAccount
- Only one POSIX account can be marked as primary.
- PosixAccount::setUsername() — Method in class PosixAccount
- The username of the POSIX account.
- PosixAccount::setUid() — Method in class PosixAccount
- The user ID.
- PosixAccount::setGid() — Method in class PosixAccount
- The default group ID.
- PosixAccount::setHomeDirectory() — Method in class PosixAccount
- The path to the home directory for this account.
- PosixAccount::setShell() — Method in class PosixAccount
- The path to the logic shell for this account.
- PosixAccount::setGecos() — Method in class PosixAccount
- The GECOS (user information) entry for this account.
- PosixAccount::setSystemId() — Method in class PosixAccount
- System identifier for which account the username or uid applies to.
- PosixAccount::setAccountId() — Method in class PosixAccount
- Output only. A POSIX account identifier.
- SshPublicKey — Class in namespace Google\Cloud\OsLogin\Common
- The SSH public key information associated with a Google account.
- SshPublicKey::setKey() — Method in class SshPublicKey
- Public key text in SSH format, defined by RFC4253 section 6.6.
- SshPublicKey::setExpirationTimeUsec() — Method in class SshPublicKey
- An expiration time in microseconds since epoch.
- SshPublicKey::setFingerprint() — Method in class SshPublicKey
- Output only. The SHA-256 fingerprint of the SSH public key.
- DeletePosixAccountRequest::setName() — Method in class DeletePosixAccountRequest
- A reference to the POSIX account to update. POSIX accounts are identified
by the project ID they are associated with. A reference to the POSIX
account is in format
users/{user}/projects/{project}. - DeleteSshPublicKeyRequest::setName() — Method in class DeleteSshPublicKeyRequest
- The fingerprint of the public key to update. Public keys are identified by
their SHA-256 fingerprint. The fingerprint of the public key is in format
users/{user}/sshPublicKeys/{fingerprint}. - GetLoginProfileRequest::setName() — Method in class GetLoginProfileRequest
- The unique ID for the user in format
users/{user}. - GetSshPublicKeyRequest::setName() — Method in class GetSshPublicKeyRequest
- The fingerprint of the public key to retrieve. Public keys are identified
by their SHA-256 fingerprint. The fingerprint of the public key is in
format
users/{user}/sshPublicKeys/{fingerprint}. - ImportSshPublicKeyRequest::setParent() — Method in class ImportSshPublicKeyRequest
- The unique ID for the user in format
users/{user}. - ImportSshPublicKeyRequest::setSshPublicKey() — Method in class ImportSshPublicKeyRequest
- The SSH public key and expiration time.
- ImportSshPublicKeyRequest::setProjectId() — Method in class ImportSshPublicKeyRequest
- The project ID of the Google Cloud Platform project.
- ImportSshPublicKeyResponse::setLoginProfile() — Method in class ImportSshPublicKeyResponse
- The login profile information for the user.
- LoginProfile::setName() — Method in class LoginProfile
- The primary email address that uniquely identifies the user.
- LoginProfile::setPosixAccounts() — Method in class LoginProfile
- The list of POSIX accounts associated with the user.
- LoginProfile::setSshPublicKeys() — Method in class LoginProfile
- A map from SSH public key fingerprint to the associated key object.
- LoginProfile::setSuspended() — Method in class LoginProfile
- Indicates if the user is suspended. A suspended user cannot log in but their profile information is retained.
- UpdateSshPublicKeyRequest::setName() — Method in class UpdateSshPublicKeyRequest
- The fingerprint of the public key to update. Public keys are identified by
their SHA-256 fingerprint. The fingerprint of the public key is in format
users/{user}/sshPublicKeys/{fingerprint}. - UpdateSshPublicKeyRequest::setSshPublicKey() — Method in class UpdateSshPublicKeyRequest
- The SSH public key and expiration time.
- UpdateSshPublicKeyRequest::setUpdateMask() — Method in class UpdateSshPublicKeyRequest
- Mask to control which fields get updated. Updates all if not present.
- AcknowledgeRequest::setSubscription() — Method in class AcknowledgeRequest
- The subscription whose message is being acknowledged.
- AcknowledgeRequest::setAckIds() — Method in class AcknowledgeRequest
- The acknowledgment ID for the messages being acknowledged that was returned
by the Pub/Sub system in the
Pullresponse. Must not be empty. - CreateSnapshotRequest::setName() — Method in class CreateSnapshotRequest
- Optional user-provided name for this snapshot.
- CreateSnapshotRequest::setSubscription() — Method in class CreateSnapshotRequest
- The subscription whose backlog the snapshot retains.
- DeleteSnapshotRequest::setSnapshot() — Method in class DeleteSnapshotRequest
- The name of the snapshot to delete.
- DeleteSubscriptionRequest::setSubscription() — Method in class DeleteSubscriptionRequest
- The subscription to delete.
- DeleteTopicRequest::setTopic() — Method in class DeleteTopicRequest
- Name of the topic to delete.
- GetSubscriptionRequest::setSubscription() — Method in class GetSubscriptionRequest
- The name of the subscription to get.
- GetTopicRequest::setTopic() — Method in class GetTopicRequest
- The name of the topic to get.
- ListSnapshotsRequest::setProject() — Method in class ListSnapshotsRequest
- The name of the cloud project that snapshots belong to.
- ListSnapshotsRequest::setPageSize() — Method in class ListSnapshotsRequest
- Maximum number of snapshots to return.
- ListSnapshotsRequest::setPageToken() — Method in class ListSnapshotsRequest
- The value returned by the last
ListSnapshotsResponse; indicates that this is a continuation of a priorListSnapshotscall, and that the system should return the next page of data. - ListSnapshotsResponse::setSnapshots() — Method in class ListSnapshotsResponse
- The resulting snapshots.
- ListSnapshotsResponse::setNextPageToken() — Method in class ListSnapshotsResponse
- If not empty, indicates that there may be more snapshot that match the
request; this value should be passed in a new
ListSnapshotsRequest. - ListSubscriptionsRequest::setProject() — Method in class ListSubscriptionsRequest
- The name of the cloud project that subscriptions belong to.
- ListSubscriptionsRequest::setPageSize() — Method in class ListSubscriptionsRequest
- Maximum number of subscriptions to return.
- ListSubscriptionsRequest::setPageToken() — Method in class ListSubscriptionsRequest
- The value returned by the last
ListSubscriptionsResponse; indicates that this is a continuation of a priorListSubscriptionscall, and that the system should return the next page of data. - ListSubscriptionsResponse::setSubscriptions() — Method in class ListSubscriptionsResponse
- The subscriptions that match the request.
- ListSubscriptionsResponse::setNextPageToken() — Method in class ListSubscriptionsResponse
- If not empty, indicates that there may be more subscriptions that match
the request; this value should be passed in a new
ListSubscriptionsRequestto get more subscriptions. - ListTopicSubscriptionsRequest::setTopic() — Method in class ListTopicSubscriptionsRequest
- The name of the topic that subscriptions are attached to.
- ListTopicSubscriptionsRequest::setPageSize() — Method in class ListTopicSubscriptionsRequest
- Maximum number of subscription names to return.
- ListTopicSubscriptionsRequest::setPageToken() — Method in class ListTopicSubscriptionsRequest
- The value returned by the last
ListTopicSubscriptionsResponse; indicates that this is a continuation of a priorListTopicSubscriptionscall, and that the system should return the next page of data. - ListTopicSubscriptionsResponse::setSubscriptions() — Method in class ListTopicSubscriptionsResponse
- The names of the subscriptions that match the request.
- ListTopicSubscriptionsResponse::setNextPageToken() — Method in class ListTopicSubscriptionsResponse
- If not empty, indicates that there may be more subscriptions that match
the request; this value should be passed in a new
ListTopicSubscriptionsRequestto get more subscriptions. - ListTopicsRequest::setProject() — Method in class ListTopicsRequest
- The name of the cloud project that topics belong to.
- ListTopicsRequest::setPageSize() — Method in class ListTopicsRequest
- Maximum number of topics to return.
- ListTopicsRequest::setPageToken() — Method in class ListTopicsRequest
- The value returned by the last
ListTopicsResponse; indicates that this is a continuation of a priorListTopicscall, and that the system should return the next page of data. - ListTopicsResponse::setTopics() — Method in class ListTopicsResponse
- The resulting topics.
- ListTopicsResponse::setNextPageToken() — Method in class ListTopicsResponse
- If not empty, indicates that there may be more topics that match the
request; this value should be passed in a new
ListTopicsRequest. - ModifyAckDeadlineRequest::setSubscription() — Method in class ModifyAckDeadlineRequest
- The name of the subscription.
- ModifyAckDeadlineRequest::setAckIds() — Method in class ModifyAckDeadlineRequest
- List of acknowledgment IDs.
- ModifyAckDeadlineRequest::setAckDeadlineSeconds() — Method in class ModifyAckDeadlineRequest
- The new ack deadline with respect to the time this request was sent to
the Pub/Sub system. For example, if the value is 10, the new
ack deadline will expire 10 seconds after the
ModifyAckDeadlinecall was made. Specifying zero may immediately make the message available for another pull request. - ModifyPushConfigRequest::setSubscription() — Method in class ModifyPushConfigRequest
- The name of the subscription.
- ModifyPushConfigRequest::setPushConfig() — Method in class ModifyPushConfigRequest
- The push configuration for future deliveries.
- PublishRequest::setTopic() — Method in class PublishRequest
- The messages in the request will be published on this topic.
- PublishRequest::setMessages() — Method in class PublishRequest
- The messages to publish.
- PublishResponse::setMessageIds() — Method in class PublishResponse
- The server-assigned ID of each published message, in the same order as the messages in the request. IDs are guaranteed to be unique within the topic.
- PubsubMessage::setData() — Method in class PubsubMessage
- The message payload.
- PubsubMessage::setAttributes() — Method in class PubsubMessage
- Optional attributes for this message.
- PubsubMessage::setMessageId() — Method in class PubsubMessage
- ID of this message, assigned by the server when the message is published.
- PubsubMessage::setPublishTime() — Method in class PubsubMessage
- The time at which the message was published, populated by the server when
it receives the
Publishcall. It must not be populated by the publisher in aPublishcall. - PullRequest::setSubscription() — Method in class PullRequest
- The subscription from which messages should be pulled.
- PullRequest::setReturnImmediately() — Method in class PullRequest
- If this field set to true, the system will respond immediately even if
it there are no messages available to return in the
Pullresponse. - PullRequest::setMaxMessages() — Method in class PullRequest
- The maximum number of messages returned for this request. The Pub/Sub system may return fewer than the number specified.
- PullResponse::setReceivedMessages() — Method in class PullResponse
- Received Pub/Sub messages. The Pub/Sub system will return zero messages if
there are no more available in the backlog. The Pub/Sub system may return
fewer than the
maxMessagesrequested even if there are more messages available in the backlog. - PushConfig::setPushEndpoint() — Method in class PushConfig
- A URL locating the endpoint to which messages should be pushed.
- PushConfig::setAttributes() — Method in class PushConfig
- Endpoint configuration attributes.
- ReceivedMessage::setAckId() — Method in class ReceivedMessage
- This ID can be used to acknowledge the received message.
- ReceivedMessage::setMessage() — Method in class ReceivedMessage
- The message.
- SeekRequest — Class in namespace Google\Cloud\PubSub\V1
- Request for the
Seekmethod. - SeekRequest::setSubscription() — Method in class SeekRequest
- The subscription to affect.
- SeekRequest::setTime() — Method in class SeekRequest
- The time to seek to.
- SeekRequest::setSnapshot() — Method in class SeekRequest
- The snapshot to seek to. The snapshot's topic must be the same as that of the provided subscription.
- SeekResponse — Class in namespace Google\Cloud\PubSub\V1
- Generated from protobuf message
google.pubsub.v1.SeekResponse - Snapshot — Class in namespace Google\Cloud\PubSub\V1
- A snapshot resource.
- Snapshot::setName() — Method in class Snapshot
- The name of the snapshot.
- Snapshot::setTopic() — Method in class Snapshot
- The name of the topic from which this snapshot is retaining messages.
- Snapshot::setExpireTime() — Method in class Snapshot
- The snapshot is guaranteed to exist up until this time.
- Snapshot::setLabels() — Method in class Snapshot
- User labels.
- StreamingPullRequest — Class in namespace Google\Cloud\PubSub\V1
- Request for the
StreamingPullstreaming RPC method. This request is used to establish the initial stream as well as to stream acknowledgements and ack deadline modifications from the client to the server. - StreamingPullRequest::setSubscription() — Method in class StreamingPullRequest
- The subscription for which to initialize the new stream. This must be provided in the first request on the stream, and must not be set in subsequent requests from client to server.
- StreamingPullRequest::setAckIds() — Method in class StreamingPullRequest
- List of acknowledgement IDs for acknowledging previously received messages
(received on this stream or a different stream). If an ack ID has expired,
the corresponding message may be redelivered later. Acknowledging a message
more than once will not result in an error. If the acknowledgement ID is
malformed, the stream will be aborted with status
INVALID_ARGUMENT. - StreamingPullRequest::setModifyDeadlineSeconds() — Method in class StreamingPullRequest
- The list of new ack deadlines for the IDs listed in
modify_deadline_ack_ids. The size of this list must be the same as the size ofmodify_deadline_ack_ids. If it differs the stream will be aborted withINVALID_ARGUMENT. Each element in this list is applied to the element in the same position inmodify_deadline_ack_ids. The new ack deadline is with respect to the time this request was sent to the Pub/Sub system. Must be >= 0. For example, if the value is 10, the new ack deadline will expire 10 seconds after this request is received. If the value is 0, the message is immediately made available for another streaming or non-streaming pull request. If the value is < 0 (an error), the stream will be aborted with statusINVALID_ARGUMENT. - StreamingPullRequest::setModifyDeadlineAckIds() — Method in class StreamingPullRequest
- List of acknowledgement IDs whose deadline will be modified based on the
corresponding element in
modify_deadline_seconds. This field can be used to indicate that more time is needed to process a message by the subscriber, or to make the message available for redelivery if the processing was interrupted. - StreamingPullRequest::setStreamAckDeadlineSeconds() — Method in class StreamingPullRequest
- The ack deadline to use for the stream. This must be provided in the first request on the stream, but it can also be updated on subsequent requests from client to server. The minimum deadline you can specify is 10 seconds. The maximum deadline you can specify is 600 seconds (10 minutes).
- StreamingPullResponse — Class in namespace Google\Cloud\PubSub\V1
- Response for the
StreamingPullmethod. This response is used to stream messages from the server to the client. - StreamingPullResponse::setReceivedMessages() — Method in class StreamingPullResponse
- Received Pub/Sub messages. This will not be empty.
- SubscriberGrpcClient — Class in namespace Google\Cloud\PubSub\V1
- The service that an application uses to manipulate subscriptions and to
consume messages from a subscription via the
Pullmethod. - SubscriberGrpcClient::StreamingPull() — Method in class SubscriberGrpcClient
- (EXPERIMENTAL) StreamingPull is an experimental feature. This RPC will respond with UNIMPLEMENTED errors unless you have been invited to test this feature. Contact cloud-pubsub@google.com with any questions.
- SubscriberGrpcClient::Seek() — Method in class SubscriberGrpcClient
- Seeks an existing subscription to a point in time or to a given snapshot, whichever is provided in the request.
- Subscription — Class in namespace Google\Cloud\PubSub\V1
- A subscription resource.
- Subscription::setName() — Method in class Subscription
- The name of the subscription. It must have the format
"projects/{project}/subscriptions/{subscription}".{subscription}must start with a letter, and contain only letters ([A-Za-z]), numbers ([0-9]), dashes (-), underscores (_), periods (.), tildes (~), plus (+) or percent signs (%). It must be between 3 and 255 characters in length, and it must not start with"goog". - Subscription::setTopic() — Method in class Subscription
- The name of the topic from which this subscription is receiving messages.
- Subscription::setPushConfig() — Method in class Subscription
- If push delivery is used with this subscription, this field is
used to configure it. An empty
pushConfigsignifies that the subscriber will pull and ack messages using API methods. - Subscription::setAckDeadlineSeconds() — Method in class Subscription
- This value is the maximum time after a subscriber receives a message before the subscriber should acknowledge the message. After message delivery but before the ack deadline expires and before the message is acknowledged, it is an outstanding message and will not be delivered again during that time (on a best-effort basis).
- Subscription::setRetainAckedMessages() — Method in class Subscription
- Indicates whether to retain acknowledged messages. If true, then
messages are not expunged from the subscription's backlog, even if they are
acknowledged, until they fall out of the
message_retention_durationwindow. - Subscription::setMessageRetentionDuration() — Method in class Subscription
- How long to retain unacknowledged messages in the subscription's backlog, from the moment a message is published.
- Subscription::setLabels() — Method in class Subscription
- User labels.
- Topic::setName() — Method in class Topic
- The name of the topic. It must have the format
"projects/{project}/topics/{topic}".{topic}must start with a letter, and contain only letters ([A-Za-z]), numbers ([0-9]), dashes (-), underscores (_), periods (.), tildes (~), plus (+) or percent signs (%). It must be between 3 and 255 characters in length, and it must not start with"goog". - Topic::setLabels() — Method in class Topic
- User labels.
- UpdateSnapshotRequest::setSnapshot() — Method in class UpdateSnapshotRequest
- The updated snpashot object.
- UpdateSnapshotRequest::setUpdateMask() — Method in class UpdateSnapshotRequest
- Indicates which fields in the provided snapshot to update.
- UpdateSubscriptionRequest::setSubscription() — Method in class UpdateSubscriptionRequest
- The updated subscription object.
- UpdateSubscriptionRequest::setUpdateMask() — Method in class UpdateSubscriptionRequest
- Indicates which fields in the provided subscription to update.
- UpdateTopicRequest::setTopic() — Method in class UpdateTopicRequest
- The topic to update.
- UpdateTopicRequest::setUpdateMask() — Method in class UpdateTopicRequest
- Indicates which fields in the provided topic to update.
- CreateInstanceRequest::setParent() — Method in class CreateInstanceRequest
- Required. The resource name of the instance location using the form:
projects/{project_id}/locations/{location_id}wherelocation_idrefers to a GCP region - CreateInstanceRequest::setInstanceId() — Method in class CreateInstanceRequest
- Required. The logical name of the Redis instance in the customer project with the following restrictions: * Must contain only lowercase letters, numbers, and hyphens.
- CreateInstanceRequest::setInstance() — Method in class CreateInstanceRequest
- Required. A Redis [Instance] resource
- DeleteInstanceRequest::setName() — Method in class DeleteInstanceRequest
- Required. Redis instance resource name using the form:
projects/{project_id}/locations/{location_id}/instances/{instance_id}wherelocation_idrefers to a GCP region - GetInstanceRequest::setName() — Method in class GetInstanceRequest
- Required. Redis instance resource name using the form:
projects/{project_id}/locations/{location_id}/instances/{instance_id}wherelocation_idrefers to a GCP region - Instance::setName() — Method in class Instance
- Required. Unique name of the resource in this scope including project and
location using the form:
projects/{project_id}/locations/{location_id}/instances/{instance_id}Note: Redis instances are managed and addressed at regional level so location_id here refers to a GCP region; however, users get to choose which specific zone (or collection of zones for cross-zone instances) an instance should be provisioned in. Refer to [location_id] and [alternative_location_id] fields for more details. - Instance::setDisplayName() — Method in class Instance
- An arbitrary and optional user-provided name for the instance.
- Instance::setLabels() — Method in class Instance
- Resource labels to represent user provided metadata
- Instance::setLocationId() — Method in class Instance
- Optional. The zone where the instance will be provisioned. If not provided, the service will choose a zone for the instance. For STANDARD_HA tier, instances will be created across two zones for protection against zonal failures. if [alternative_location_id] is also provided, it must be different from [location_id].
- Instance::setAlternativeLocationId() — Method in class Instance
- Optional. Only applicable to STANDARD_HA tier which protects the instance against zonal failures by provisioning it across two zones. If provided, it must be a different zone from the one provided in [location_id].
- Instance::setRedisVersion() — Method in class Instance
- Optional. The version of Redis software.
- Instance::setReservedIpRange() — Method in class Instance
- Optional. The CIDR range of internal addresses that are reserved for this instance. If not provided, the service will choose an unused /29 block, for example, 10.0.0.0/29 or 192.168.0.0/29. Ranges must be unique and non-overlapping with existing subnets in a network.
- Instance::setHost() — Method in class Instance
- Output only. Hostname or IP address of the exposed redis endpoint used by clients to connect to the service.
- Instance::setPort() — Method in class Instance
- Output only. The port number of the exposed redis endpoint.
- Instance::setCurrentLocationId() — Method in class Instance
- Output only. The current zone where the Redis endpoint is placed. In single zone deployments, this will always be the same as [location_id] provided by the user at creation time. In cross-zone instances (only applicable in STANDARD_HA tier), this can be either [location_id] or [alternative_location_id] and can change on a failover event.
- Instance::setCreateTime() — Method in class Instance
- Output only. The time the instance was created.
- Instance::setState() — Method in class Instance
- Output only. The current state of this instance.
- Instance::setStatusMessage() — Method in class Instance
- Output only. Additional information about the current status of this instance, if available.
- Instance::setRedisConfigs() — Method in class Instance
- Optional. Redis configuration parameters, according to http://redis.io/topics/config. Currently, the only supported parameters are: * maxmemory-policy * notify-keyspace-events
- Instance::setTier() — Method in class Instance
- Required. The service tier of the instance.
- Instance::setMemorySizeGb() — Method in class Instance
- Required. Redis memory size in GB.
- Instance::setAuthorizedNetwork() — Method in class Instance
- Optional. The full name of the Google Compute Engine
network to which the
instance is connected. If left unspecified, the
defaultnetwork will be used. - ListInstancesRequest::setParent() — Method in class ListInstancesRequest
- Required. The resource name of the instance location using the form:
projects/{project_id}/locations/{location_id}wherelocation_idrefers to a GCP region - ListInstancesRequest::setPageSize() — Method in class ListInstancesRequest
- The maximum number of items to return.
- ListInstancesRequest::setPageToken() — Method in class ListInstancesRequest
- The next_page_token value returned from a previous List request, if any.
- ListInstancesResponse::setInstances() — Method in class ListInstancesResponse
- A list of Redis instances in the project in the specified location, or across all locations.
- ListInstancesResponse::setNextPageToken() — Method in class ListInstancesResponse
- Token to retrieve the next page of results, or empty if there are no more results in the list.
- LocationMetadata::setAvailableZones() — Method in class LocationMetadata
- Output only. The set of available zones in the location. The map is keyed
by the lowercase ID of each zone, as defined by GCE. These keys can be
specified in
location_idoralternative_location_idfields when creating a Redis instance. - UpdateInstanceRequest::setUpdateMask() — Method in class UpdateInstanceRequest
- Required. Mask of fields to update. At least one path must be supplied in
this field. The elements of the repeated paths field may only include these
fields from [Instance][CloudRedis.Instance]:
*
display_name*labels*memory_size_gb*redis_config - UpdateInstanceRequest::setInstance() — Method in class UpdateInstanceRequest
- Required. Update description.
- CreateDatabaseMetadata::setDatabase() — Method in class CreateDatabaseMetadata
- The database being created.
- CreateDatabaseRequest::setParent() — Method in class CreateDatabaseRequest
- Required. The name of the instance that will serve the new database.
- CreateDatabaseRequest::setCreateStatement() — Method in class CreateDatabaseRequest
- Required. A
CREATE DATABASEstatement, which specifies the ID of the new database. The database ID must conform to the regular expression[a-z][a-z0-9_\-]*[a-z0-9]and be between 2 and 30 characters in length. - CreateDatabaseRequest::setExtraStatements() — Method in class CreateDatabaseRequest
- An optional list of DDL statements to run inside the newly created database. Statements can create tables, indexes, etc. These statements execute atomically with the creation of the database: if there is an error in any statement, the database is not created.
- Database::setName() — Method in class Database
- Required. The name of the database. Values are of the form
projects/<project>/instances/<instance>/databases/<database>, where<database>is as specified in theCREATE DATABASEstatement. This name can be passed to other API methods to identify the database. - Database::setState() — Method in class Database
- Output only. The current database state.
- DatabaseAdminGrpcClient::SetIamPolicy() — Method in class DatabaseAdminGrpcClient
- Sets the access control policy on a database resource. Replaces any existing policy.
- DropDatabaseRequest::setDatabase() — Method in class DropDatabaseRequest
- Required. The database to be dropped.
- GetDatabaseDdlRequest::setDatabase() — Method in class GetDatabaseDdlRequest
- Required. The database whose schema we wish to get.
- GetDatabaseDdlResponse::setStatements() — Method in class GetDatabaseDdlResponse
- A list of formatted DDL statements defining the schema of the database specified in the request.
- GetDatabaseRequest::setName() — Method in class GetDatabaseRequest
- Required. The name of the requested database. Values are of the form
projects/<project>/instances/<instance>/databases/<database>. - ListDatabasesRequest::setParent() — Method in class ListDatabasesRequest
- Required. The instance whose databases should be listed.
- ListDatabasesRequest::setPageSize() — Method in class ListDatabasesRequest
- Number of databases to be returned in the response. If 0 or less, defaults to the server's maximum allowed page size.
- ListDatabasesRequest::setPageToken() — Method in class ListDatabasesRequest
- If non-empty,
page_tokenshould contain a [next_page_token][google.spanner.admin.database.v1.ListDatabasesResponse.next_page_token] from a previous [ListDatabasesResponse][google.spanner.admin.database.v1.ListDatabasesResponse]. - ListDatabasesResponse::setDatabases() — Method in class ListDatabasesResponse
- Databases that matched the request.
- ListDatabasesResponse::setNextPageToken() — Method in class ListDatabasesResponse
next_page_tokencan be sent in a subsequent [ListDatabases][google.spanner.admin.database.v1.DatabaseAdmin.ListDatabases] call to fetch more of the matching databases.- UpdateDatabaseDdlMetadata::setDatabase() — Method in class UpdateDatabaseDdlMetadata
- The database being modified.
- UpdateDatabaseDdlMetadata::setStatements() — Method in class UpdateDatabaseDdlMetadata
- For an update this list contains all the statements. For an individual statement, this list contains only that statement.
- UpdateDatabaseDdlMetadata::setCommitTimestamps() — Method in class UpdateDatabaseDdlMetadata
- Reports the commit timestamps of all statements that have
succeeded so far, where
commit_timestamps[i]is the commit timestamp for the statementstatements[i]. - UpdateDatabaseDdlRequest::setDatabase() — Method in class UpdateDatabaseDdlRequest
- Required. The database to update.
- UpdateDatabaseDdlRequest::setStatements() — Method in class UpdateDatabaseDdlRequest
- DDL statements to be applied to the database.
- UpdateDatabaseDdlRequest::setOperationId() — Method in class UpdateDatabaseDdlRequest
- If empty, the new update request is assigned an
automatically-generated operation ID. Otherwise,
operation_idis used to construct the name of the resulting [Operation][google.longrunning.Operation]. - CreateInstanceMetadata::setInstance() — Method in class CreateInstanceMetadata
- The instance being created.
- CreateInstanceMetadata::setStartTime() — Method in class CreateInstanceMetadata
- The time at which the [CreateInstance][google.spanner.admin.instance.v1.InstanceAdmin.CreateInstance] request was received.
- CreateInstanceMetadata::setCancelTime() — Method in class CreateInstanceMetadata
- The time at which this operation was cancelled. If set, this operation is in the process of undoing itself (which is guaranteed to succeed) and cannot be cancelled again.
- CreateInstanceMetadata::setEndTime() — Method in class CreateInstanceMetadata
- The time at which this operation failed or was completed successfully.
- CreateInstanceRequest::setParent() — Method in class CreateInstanceRequest
- Required. The name of the project in which to create the instance. Values
are of the form
projects/<project>. - CreateInstanceRequest::setInstanceId() — Method in class CreateInstanceRequest
- Required. The ID of the instance to create. Valid identifiers are of the
form
[a-z][-a-z0-9]*[a-z0-9]and must be between 6 and 30 characters in length. - CreateInstanceRequest::setInstance() — Method in class CreateInstanceRequest
- Required. The instance to create. The name may be omitted, but if
specified must be
<parent>/instances/<instance_id>. - DeleteInstanceRequest::setName() — Method in class DeleteInstanceRequest
- Required. The name of the instance to be deleted. Values are of the form
projects/<project>/instances/<instance> - GetInstanceConfigRequest::setName() — Method in class GetInstanceConfigRequest
- Required. The name of the requested instance configuration. Values are of
the form
projects/<project>/instanceConfigs/<config>. - GetInstanceRequest::setName() — Method in class GetInstanceRequest
- Required. The name of the requested instance. Values are of the form
projects/<project>/instances/<instance>. - Instance::setName() — Method in class Instance
- Required. A unique identifier for the instance, which cannot be changed
after the instance is created. Values are of the form
projects/<project>/instances/[a-z][-a-z0-9]*[a-z0-9]. The final segment of the name must be between 6 and 30 characters in length. - Instance::setConfig() — Method in class Instance
- Required. The name of the instance's configuration. Values are of the form
projects/<project>/instanceConfigs/<configuration>. See also [InstanceConfig][google.spanner.admin.instance.v1.InstanceConfig] and [ListInstanceConfigs][google.spanner.admin.instance.v1.InstanceAdmin.ListInstanceConfigs]. - Instance::setDisplayName() — Method in class Instance
- Required. The descriptive name for this instance as it appears in UIs.
- Instance::setNodeCount() — Method in class Instance
- Required. The number of nodes allocated to this instance. This may be zero
in API responses for instances that are not yet in state
READY. - Instance::setState() — Method in class Instance
- Output only. The current instance state. For
[CreateInstance][google.spanner.admin.instance.v1.InstanceAdmin.CreateInstance], the state must be
either omitted or set to
CREATING. For [UpdateInstance][google.spanner.admin.instance.v1.InstanceAdmin.UpdateInstance], the state must be either omitted or set toREADY. - Instance::setLabels() — Method in class Instance
- Cloud Labels are a flexible and lightweight mechanism for organizing cloud resources into groups that reflect a customer's organizational needs and deployment strategies. Cloud Labels can be used to filter collections of resources. They can be used to control how resource metrics are aggregated.
- InstanceAdminGrpcClient::SetIamPolicy() — Method in class InstanceAdminGrpcClient
- Sets the access control policy on an instance resource. Replaces any existing policy.
- InstanceConfig::setName() — Method in class InstanceConfig
- A unique identifier for the instance configuration. Values
are of the form
projects/<project>/instanceConfigs/[a-z][-a-z0-9]* - InstanceConfig::setDisplayName() — Method in class InstanceConfig
- The name of this instance configuration as it appears in UIs.
- ListInstanceConfigsRequest::setParent() — Method in class ListInstanceConfigsRequest
- Required. The name of the project for which a list of supported instance
configurations is requested. Values are of the form
projects/<project>. - ListInstanceConfigsRequest::setPageSize() — Method in class ListInstanceConfigsRequest
- Number of instance configurations to be returned in the response. If 0 or less, defaults to the server's maximum allowed page size.
- ListInstanceConfigsRequest::setPageToken() — Method in class ListInstanceConfigsRequest
- If non-empty,
page_tokenshould contain a [next_page_token][google.spanner.admin.instance.v1.ListInstanceConfigsResponse.next_page_token] from a previous [ListInstanceConfigsResponse][google.spanner.admin.instance.v1.ListInstanceConfigsResponse]. - ListInstanceConfigsResponse::setInstanceConfigs() — Method in class ListInstanceConfigsResponse
- The list of requested instance configurations.
- ListInstanceConfigsResponse::setNextPageToken() — Method in class ListInstanceConfigsResponse
next_page_tokencan be sent in a subsequent [ListInstanceConfigs][google.spanner.admin.instance.v1.InstanceAdmin.ListInstanceConfigs] call to fetch more of the matching instance configurations.- ListInstancesRequest::setParent() — Method in class ListInstancesRequest
- Required. The name of the project for which a list of instances is
requested. Values are of the form
projects/<project>. - ListInstancesRequest::setPageSize() — Method in class ListInstancesRequest
- Number of instances to be returned in the response. If 0 or less, defaults to the server's maximum allowed page size.
- ListInstancesRequest::setPageToken() — Method in class ListInstancesRequest
- If non-empty,
page_tokenshould contain a [next_page_token][google.spanner.admin.instance.v1.ListInstancesResponse.next_page_token] from a previous [ListInstancesResponse][google.spanner.admin.instance.v1.ListInstancesResponse]. - ListInstancesRequest::setFilter() — Method in class ListInstancesRequest
- An expression for filtering the results of the request. Filter rules are
case insensitive. The fields eligible for filtering are:
*
name*display_name*labels.keywhere key is the name of a label Some examples of using filters are: *name:*--> The instance has a name. - ListInstancesResponse::setInstances() — Method in class ListInstancesResponse
- The list of requested instances.
- ListInstancesResponse::setNextPageToken() — Method in class ListInstancesResponse
next_page_tokencan be sent in a subsequent [ListInstances][google.spanner.admin.instance.v1.InstanceAdmin.ListInstances] call to fetch more of the matching instances.- UpdateInstanceMetadata::setInstance() — Method in class UpdateInstanceMetadata
- The desired end state of the update.
- UpdateInstanceMetadata::setStartTime() — Method in class UpdateInstanceMetadata
- The time at which [UpdateInstance][google.spanner.admin.instance.v1.InstanceAdmin.UpdateInstance] request was received.
- UpdateInstanceMetadata::setCancelTime() — Method in class UpdateInstanceMetadata
- The time at which this operation was cancelled. If set, this operation is in the process of undoing itself (which is guaranteed to succeed) and cannot be cancelled again.
- UpdateInstanceMetadata::setEndTime() — Method in class UpdateInstanceMetadata
- The time at which this operation failed or was completed successfully.
- UpdateInstanceRequest::setInstance() — Method in class UpdateInstanceRequest
- Required. The instance to update, which must always include the instance name. Otherwise, only fields mentioned in [][google.spanner.admin.instance.v1.UpdateInstanceRequest.field_mask] need be included.
- UpdateInstanceRequest::setFieldMask() — Method in class UpdateInstanceRequest
- Required. A mask specifying which fields in [][google.spanner.admin.instance.v1.UpdateInstanceRequest.instance] should be updated.
- BeginTransactionRequest::setSession() — Method in class BeginTransactionRequest
- Required. The session in which the transaction runs.
- BeginTransactionRequest::setOptions() — Method in class BeginTransactionRequest
- Required. Options for the new transaction.
- CommitRequest::setSession() — Method in class CommitRequest
- Required. The session in which the transaction to be committed is running.
- CommitRequest::setTransactionId() — Method in class CommitRequest
- Commit a previously-started transaction.
- CommitRequest::setSingleUseTransaction() — Method in class CommitRequest
- Execute mutations in a temporary transaction. Note that unlike
commit of a previously-started transaction, commit with a
temporary transaction is non-idempotent. That is, if the
CommitRequestis sent to Cloud Spanner more than once (for instance, due to retries in the application, or in the transport library), it is possible that the mutations are executed more than once. If this is undesirable, use [BeginTransaction][google.spanner.v1.Spanner.BeginTransaction] and [Commit][google.spanner.v1.Spanner.Commit] instead. - CommitRequest::setMutations() — Method in class CommitRequest
- The mutations to be executed when this transaction commits. All mutations are applied atomically, in the order they appear in this list.
- CommitResponse::setCommitTimestamp() — Method in class CommitResponse
- The Cloud Spanner timestamp at which the transaction committed.
- CreateSessionRequest::setDatabase() — Method in class CreateSessionRequest
- Required. The database in which the new session is created.
- CreateSessionRequest::setSession() — Method in class CreateSessionRequest
- The session to create.
- DeleteSessionRequest::setName() — Method in class DeleteSessionRequest
- Required. The name of the session to delete.
- ExecuteSqlRequest::setSession() — Method in class ExecuteSqlRequest
- Required. The session in which the SQL query should be performed.
- ExecuteSqlRequest::setTransaction() — Method in class ExecuteSqlRequest
- The transaction to use. If none is provided, the default is a temporary read-only transaction with strong concurrency.
- ExecuteSqlRequest::setSql() — Method in class ExecuteSqlRequest
- Required. The SQL query string.
- ExecuteSqlRequest::setParams() — Method in class ExecuteSqlRequest
- The SQL query string can contain parameter placeholders. A parameter
placeholder consists of
'@'followed by the parameter name. Parameter names consist of any combination of letters, numbers, and underscores. - ExecuteSqlRequest::setParamTypes() — Method in class ExecuteSqlRequest
- It is not always possible for Cloud Spanner to infer the right SQL type
from a JSON value. For example, values of type
BYTESand values of typeSTRINGboth appear in [params][google.spanner.v1.ExecuteSqlRequest.params] as JSON strings. - ExecuteSqlRequest::setResumeToken() — Method in class ExecuteSqlRequest
- If this request is resuming a previously interrupted SQL query
execution,
resume_tokenshould be copied from the last [PartialResultSet][google.spanner.v1.PartialResultSet] yielded before the interruption. Doing this enables the new SQL query execution to resume where the last one left off. The rest of the request parameters must exactly match the request that yielded this token. - ExecuteSqlRequest::setQueryMode() — Method in class ExecuteSqlRequest
- Used to control the amount of debugging information returned in [ResultSetStats][google.spanner.v1.ResultSetStats]. If [partition_token][google.spanner.v1.ExecuteSqlRequest.partition_token] is set, [query_mode][google.spanner.v1.ExecuteSqlRequest.query_mode] can only be set to [QueryMode.NORMAL][google.spanner.v1.ExecuteSqlRequest.QueryMode.NORMAL].
- ExecuteSqlRequest::setPartitionToken() — Method in class ExecuteSqlRequest
- If present, results will be restricted to the specified partition previously created using PartitionQuery(). There must be an exact match for the values of fields common to this message and the PartitionQueryRequest message used to create this partition_token.
- GetSessionRequest::setName() — Method in class GetSessionRequest
- Required. The name of the session to retrieve.
- $KeyRange#start_key_type — Property in class KeyRange
- KeyRange::setStartClosed() — Method in class KeyRange
- If the start is closed, then the range includes all rows whose
first
len(start_closed)key columns exactly matchstart_closed. - KeyRange::setStartOpen() — Method in class KeyRange
- If the start is open, then the range excludes rows whose first
len(start_open)key columns exactly matchstart_open. - KeyRange::setEndClosed() — Method in class KeyRange
- If the end is closed, then the range includes all rows whose
first
len(end_closed)key columns exactly matchend_closed. - KeyRange::setEndOpen() — Method in class KeyRange
- If the end is open, then the range excludes rows whose first
len(end_open)key columns exactly matchend_open. - KeySet::setKeys() — Method in class KeySet
- A list of specific keys. Entries in
keysshould have exactly as many elements as there are columns in the primary or index key with which thisKeySetis used. Individual key values are encoded as described [here][google.spanner.v1.TypeCode]. - KeySet::setRanges() — Method in class KeySet
- A list of key ranges. See [KeyRange][google.spanner.v1.KeyRange] for more information about key range specifications.
- KeySet::setAll() — Method in class KeySet
- For convenience
allcan be set totrueto indicate that thisKeySetmatches all keys in the table or index. Note that any keys specified inkeysorrangesare only yielded once. - ListSessionsRequest::setDatabase() — Method in class ListSessionsRequest
- Required. The database in which to list sessions.
- ListSessionsRequest::setPageSize() — Method in class ListSessionsRequest
- Number of sessions to be returned in the response. If 0 or less, defaults to the server's maximum allowed page size.
- ListSessionsRequest::setPageToken() — Method in class ListSessionsRequest
- If non-empty,
page_tokenshould contain a [next_page_token][google.spanner.v1.ListSessionsResponse.next_page_token] from a previous [ListSessionsResponse][google.spanner.v1.ListSessionsResponse]. - ListSessionsRequest::setFilter() — Method in class ListSessionsRequest
- An expression for filtering the results of the request. Filter rules are
case insensitive. The fields eligible for filtering are:
*
labels.keywhere key is the name of a label Some examples of using filters are: *labels.env:*--> The session has the label "env". - ListSessionsResponse::setSessions() — Method in class ListSessionsResponse
- The list of requested sessions.
- ListSessionsResponse::setNextPageToken() — Method in class ListSessionsResponse
next_page_tokencan be sent in a subsequent [ListSessions][google.spanner.v1.Spanner.ListSessions] call to fetch more of the matching sessions.- Mutation::setInsert() — Method in class Mutation
- Insert new rows in a table. If any of the rows already exist,
the write or transaction fails with error
ALREADY_EXISTS. - Mutation::setUpdate() — Method in class Mutation
- Update existing rows in a table. If any of the rows does not
already exist, the transaction fails with error
NOT_FOUND. - Mutation::setInsertOrUpdate() — Method in class Mutation
- Like [insert][google.spanner.v1.Mutation.insert], except that if the row already exists, then its column values are overwritten with the ones provided. Any column values not explicitly written are preserved.
- Mutation::setReplace() — Method in class Mutation
- Like [insert][google.spanner.v1.Mutation.insert], except that if the row already exists, it is
deleted, and the column values provided are inserted
instead. Unlike [insert_or_update][google.spanner.v1.Mutation.insert_or_update], this means any values not
explicitly written become
NULL. - Mutation::setDelete() — Method in class Mutation
- Delete rows from a table. Succeeds whether or not the named rows were present.
- Mutation_Delete::setTable() — Method in class Mutation_Delete
- Required. The table whose rows will be deleted.
- Mutation_Delete::setKeySet() — Method in class Mutation_Delete
- Required. The primary keys of the rows within [table][google.spanner.v1.Mutation.Delete.table] to delete.
- Mutation_Write::setTable() — Method in class Mutation_Write
- Required. The table whose rows will be written.
- Mutation_Write::setColumns() — Method in class Mutation_Write
- The names of the columns in [table][google.spanner.v1.Mutation.Write.table] to be written.
- Mutation_Write::setValues() — Method in class Mutation_Write
- The values to be written.
valuescan contain more than one list of values. If it does, then multiple rows are written, one for each entry invalues. Each list invaluesmust have exactly as many entries as there are entries in [columns][google.spanner.v1.Mutation.Write.columns] above. Sending multiple lists is equivalent to sending multipleMutations, each containing onevaluesentry and repeating [table][google.spanner.v1.Mutation.Write.table] and [columns][google.spanner.v1.Mutation.Write.columns]. Individual values in each list are encoded as described [here][google.spanner.v1.TypeCode]. - PartialResultSet::setMetadata() — Method in class PartialResultSet
- Metadata about the result set, such as row type information.
- PartialResultSet::setValues() — Method in class PartialResultSet
- A streamed result set consists of a stream of values, which might
be split into many
PartialResultSetmessages to accommodate large rows and/or large values. Every N complete values defines a row, where N is equal to the number of entries in [metadata.row_type.fields][google.spanner.v1.StructType.fields]. - PartialResultSet::setChunkedValue() — Method in class PartialResultSet
- If true, then the final value in [values][google.spanner.v1.PartialResultSet.values] is chunked, and must
be combined with more values from subsequent
PartialResultSets to obtain a complete field value. - PartialResultSet::setResumeToken() — Method in class PartialResultSet
- Streaming calls might be interrupted for a variety of reasons, such
as TCP connection loss. If this occurs, the stream of results can
be resumed by re-sending the original request and including
resume_token. Note that executing any other transaction in the same session invalidates the token. - PartialResultSet::setStats() — Method in class PartialResultSet
- Query plan and execution statistics for the query that produced this streaming result set. These can be requested by setting [ExecuteSqlRequest.query_mode][google.spanner.v1.ExecuteSqlRequest.query_mode] and are sent only once with the last response in the stream.
- Partition::setPartitionToken() — Method in class Partition
- This token can be passed to Read, StreamingRead, ExecuteSql, or ExecuteStreamingSql requests to restrict the results to those identified by this partition token.
- PartitionOptions::setPartitionSizeBytes() — Method in class PartitionOptions
- Note: This hint is currently ignored by PartitionQuery and PartitionRead requests.
- PartitionOptions::setMaxPartitions() — Method in class PartitionOptions
- Note: This hint is currently ignored by PartitionQuery and PartitionRead requests.
- PartitionQueryRequest::setSession() — Method in class PartitionQueryRequest
- Required. The session used to create the partitions.
- PartitionQueryRequest::setTransaction() — Method in class PartitionQueryRequest
- Read only snapshot transactions are supported, read/write and single use transactions are not.
- PartitionQueryRequest::setSql() — Method in class PartitionQueryRequest
- The query request to generate partitions for. The request will fail if the query is not root partitionable. The query plan of a root partitionable query has a single distributed union operator. A distributed union operator conceptually divides one or more tables into multiple splits, remotely evaluates a subquery independently on each split, and then unions all results.
- PartitionQueryRequest::setParams() — Method in class PartitionQueryRequest
- The SQL query string can contain parameter placeholders. A parameter
placeholder consists of
'@'followed by the parameter name. Parameter names consist of any combination of letters, numbers, and underscores. - PartitionQueryRequest::setParamTypes() — Method in class PartitionQueryRequest
- It is not always possible for Cloud Spanner to infer the right SQL type
from a JSON value. For example, values of type
BYTESand values of typeSTRINGboth appear in [params][google.spanner.v1.PartitionQueryRequest.params] as JSON strings. - PartitionQueryRequest::setPartitionOptions() — Method in class PartitionQueryRequest
- Additional options that affect how many partitions are created.
- PartitionReadRequest::setSession() — Method in class PartitionReadRequest
- Required. The session used to create the partitions.
- PartitionReadRequest::setTransaction() — Method in class PartitionReadRequest
- Read only snapshot transactions are supported, read/write and single use transactions are not.
- PartitionReadRequest::setTable() — Method in class PartitionReadRequest
- Required. The name of the table in the database to be read.
- PartitionReadRequest::setIndex() — Method in class PartitionReadRequest
- If non-empty, the name of an index on [table][google.spanner.v1.PartitionReadRequest.table]. This index is used instead of the table primary key when interpreting [key_set][google.spanner.v1.PartitionReadRequest.key_set] and sorting result rows. See [key_set][google.spanner.v1.PartitionReadRequest.key_set] for further information.
- PartitionReadRequest::setColumns() — Method in class PartitionReadRequest
- The columns of [table][google.spanner.v1.PartitionReadRequest.table] to be returned for each row matching this request.
- PartitionReadRequest::setKeySet() — Method in class PartitionReadRequest
- Required.
key_setidentifies the rows to be yielded.key_setnames the primary keys of the rows in [table][google.spanner.v1.PartitionReadRequest.table] to be yielded, unless [index][google.spanner.v1.PartitionReadRequest.index] is present. If [index][google.spanner.v1.PartitionReadRequest.index] is present, then [key_set][google.spanner.v1.PartitionReadRequest.key_set] instead names index keys in [index][google.spanner.v1.PartitionReadRequest.index]. - PartitionReadRequest::setPartitionOptions() — Method in class PartitionReadRequest
- Additional options that affect how many partitions are created.
- PartitionResponse::setPartitions() — Method in class PartitionResponse
- Partitions created by this request.
- PartitionResponse::setTransaction() — Method in class PartitionResponse
- Transaction created by this request.
- PlanNode::setIndex() — Method in class PlanNode
- The
PlanNode's index in [node list][google.spanner.v1.QueryPlan.plan_nodes]. - PlanNode::setKind() — Method in class PlanNode
- Used to determine the type of node. May be needed for visualizing different kinds of nodes differently. For example, If the node is a [SCALAR][google.spanner.v1.PlanNode.Kind.SCALAR] node, it will have a condensed representation which can be used to directly embed a description of the node in its parent.
- PlanNode::setDisplayName() — Method in class PlanNode
- The display name for the node.
- PlanNode::setChildLinks() — Method in class PlanNode
- List of child node
indexes and their relationship to this parent. - PlanNode::setShortRepresentation() — Method in class PlanNode
- Condensed representation for [SCALAR][google.spanner.v1.PlanNode.Kind.SCALAR] nodes.
- PlanNode::setMetadata() — Method in class PlanNode
- Attributes relevant to the node contained in a group of key-value pairs.
- PlanNode::setExecutionStats() — Method in class PlanNode
- The execution statistics associated with the node, contained in a group of key-value pairs. Only present if the plan was returned as a result of a profile query. For example, number of executions, number of rows/time per execution etc.
- PlanNode_ChildLink::setChildIndex() — Method in class PlanNode_ChildLink
- The node to which the link points.
- PlanNode_ChildLink::setType() — Method in class PlanNode_ChildLink
- The type of the link. For example, in Hash Joins this could be used to distinguish between the build child and the probe child, or in the case of the child being an output variable, to represent the tag associated with the output variable.
- PlanNode_ChildLink::setVariable() — Method in class PlanNode_ChildLink
- Only present if the child node is [SCALAR][google.spanner.v1.PlanNode.Kind.SCALAR] and corresponds to an output variable of the parent node. The field carries the name of the output variable.
- PlanNode_ShortRepresentation::setDescription() — Method in class PlanNode_ShortRepresentation
- A string representation of the expression subtree rooted at this node.
- PlanNode_ShortRepresentation::setSubqueries() — Method in class PlanNode_ShortRepresentation
- A mapping of (subquery variable name) -> (subquery node id) for cases
where the
descriptionstring of this node references aSCALARsubquery contained in the expression subtree rooted at this node. The referencedSCALARsubquery may not necessarily be a direct child of this node. - QueryPlan::setPlanNodes() — Method in class QueryPlan
- The nodes in the query plan. Plan nodes are returned in pre-order starting
with the plan root. Each [PlanNode][google.spanner.v1.PlanNode]'s
idcorresponds to its index inplan_nodes. - ReadRequest::setSession() — Method in class ReadRequest
- Required. The session in which the read should be performed.
- ReadRequest::setTransaction() — Method in class ReadRequest
- The transaction to use. If none is provided, the default is a temporary read-only transaction with strong concurrency.
- ReadRequest::setTable() — Method in class ReadRequest
- Required. The name of the table in the database to be read.
- ReadRequest::setIndex() — Method in class ReadRequest
- If non-empty, the name of an index on [table][google.spanner.v1.ReadRequest.table]. This index is used instead of the table primary key when interpreting [key_set][google.spanner.v1.ReadRequest.key_set] and sorting result rows. See [key_set][google.spanner.v1.ReadRequest.key_set] for further information.
- ReadRequest::setColumns() — Method in class ReadRequest
- The columns of [table][google.spanner.v1.ReadRequest.table] to be returned for each row matching this request.
- ReadRequest::setKeySet() — Method in class ReadRequest
- Required.
key_setidentifies the rows to be yielded.key_setnames the primary keys of the rows in [table][google.spanner.v1.ReadRequest.table] to be yielded, unless [index][google.spanner.v1.ReadRequest.index] is present. If [index][google.spanner.v1.ReadRequest.index] is present, then [key_set][google.spanner.v1.ReadRequest.key_set] instead names index keys in [index][google.spanner.v1.ReadRequest.index]. - ReadRequest::setLimit() — Method in class ReadRequest
- If greater than zero, only the first
limitrows are yielded. Iflimitis zero, the default is no limit. A limit cannot be specified ifpartition_tokenis set. - ReadRequest::setResumeToken() — Method in class ReadRequest
- If this request is resuming a previously interrupted read,
resume_tokenshould be copied from the last [PartialResultSet][google.spanner.v1.PartialResultSet] yielded before the interruption. Doing this enables the new read to resume where the last read left off. The rest of the request parameters must exactly match the request that yielded this token. - ReadRequest::setPartitionToken() — Method in class ReadRequest
- If present, results will be restricted to the specified partition previously created using PartitionRead(). There must be an exact match for the values of fields common to this message and the PartitionReadRequest message used to create this partition_token.
- ResultSet::setMetadata() — Method in class ResultSet
- Metadata about the result set, such as row type information.
- ResultSet::setRows() — Method in class ResultSet
- Each element in
rowsis a row whose format is defined by [metadata.row_type][google.spanner.v1.ResultSetMetadata.row_type]. The ith element in each row matches the ith field in [metadata.row_type][google.spanner.v1.ResultSetMetadata.row_type]. Elements are encoded based on type as described [here][google.spanner.v1.TypeCode]. - ResultSet::setStats() — Method in class ResultSet
- Query plan and execution statistics for the query that produced this result set. These can be requested by setting [ExecuteSqlRequest.query_mode][google.spanner.v1.ExecuteSqlRequest.query_mode].
- ResultSetMetadata::setRowType() — Method in class ResultSetMetadata
- Indicates the field names and types for the rows in the result
set. For example, a SQL query like
"SELECT UserId, UserName FROM Users"could return arow_typevalue like: "fields": [ { "name": "UserId", "type": { "code": "INT64" } }, { "name": "UserName", "type": { "code": "STRING" } }, ] - ResultSetMetadata::setTransaction() — Method in class ResultSetMetadata
- If the read or SQL query began a transaction as a side-effect, the information about the new transaction is yielded here.
- ResultSetStats::setQueryPlan() — Method in class ResultSetStats
- [QueryPlan][google.spanner.v1.QueryPlan] for the query associated with this result.
- ResultSetStats::setQueryStats() — Method in class ResultSetStats
- Aggregated statistics from the execution of the query. Only present when the query is profiled. For example, a query could return the statistics as follows: { "rows_returned": "3", "elapsed_time": "1.22 secs", "cpu_time": "1.19 secs" }
- RollbackRequest::setSession() — Method in class RollbackRequest
- Required. The session in which the transaction to roll back is running.
- RollbackRequest::setTransactionId() — Method in class RollbackRequest
- Required. The transaction to roll back.
- Session — Class in namespace Google\Cloud\Spanner\V1
- A session in the Cloud Spanner API.
- Session::setName() — Method in class Session
- The name of the session. This is always system-assigned; values provided when creating a session are ignored.
- Session::setLabels() — Method in class Session
- The labels for the session.
- Session::setCreateTime() — Method in class Session
- Output only. The timestamp when the session is created.
- Session::setApproximateLastUseTime() — Method in class Session
- Output only. The approximate timestamp when the session is last used. It is typically earlier than the actual last use time.
- SpannerGrpcClient — Class in namespace Google\Cloud\Spanner\V1
- Cloud Spanner API
- SpannerGrpcClient::StreamingRead() — Method in class SpannerGrpcClient
- Like [Read][google.spanner.v1.Spanner.Read], except returns the result set as a stream. Unlike [Read][google.spanner.v1.Spanner.Read], there is no limit on the size of the returned result set. However, no individual row in the result set can exceed 100 MiB, and no column value can exceed 10 MiB.
- StructType — Class in namespace Google\Cloud\Spanner\V1
StructTypedefines the fields of a [STRUCT][google.spanner.v1.TypeCode.STRUCT] type.- StructType::setFields() — Method in class StructType
- The list of fields that make up this struct. Order is
significant, because values of this struct type are represented as
lists, where the order of field values matches the order of
fields in the [StructType][google.spanner.v1.StructType]. In turn, the order of fields
matches the order of columns in a read request, or the order of
fields in the
SELECTclause of a query. - StructType_Field — Class in namespace Google\Cloud\Spanner\V1
- Message representing a single field of a struct.
- StructType_Field::setName() — Method in class StructType_Field
- The name of the field. For reads, this is the column name. For
SQL queries, it is the column alias (e.g.,
"Word"in the query"SELECT 'hello' AS Word"), or the column name (e.g.,"ColName"in the query"SELECT ColName FROM Table"). Some columns might have an empty name (e.g., !"SELECT UPPER(ColName)"`). Note that a query result can contain multiple fields with the same name. - StructType_Field::setType() — Method in class StructType_Field
- The type of the field.
- Transaction::setId() — Method in class Transaction
idmay be used to identify the transaction in subsequent [Read][google.spanner.v1.Spanner.Read], [ExecuteSql][google.spanner.v1.Spanner.ExecuteSql], [Commit][google.spanner.v1.Spanner.Commit], or [Rollback][google.spanner.v1.Spanner.Rollback] calls.- Transaction::setReadTimestamp() — Method in class Transaction
- For snapshot read-only transactions, the read timestamp chosen for the transaction. Not returned by default: see [TransactionOptions.ReadOnly.return_read_timestamp][google.spanner.v1.TransactionOptions.ReadOnly.return_read_timestamp].
- TransactionOptions::setReadWrite() — Method in class TransactionOptions
- Transaction may write.
- TransactionOptions::setReadOnly() — Method in class TransactionOptions
- Transaction will not write.
- TransactionOptions_ReadOnly::setStrong() — Method in class TransactionOptions_ReadOnly
- Read at a timestamp where all previously committed transactions are visible.
- TransactionOptions_ReadOnly::setMinReadTimestamp() — Method in class TransactionOptions_ReadOnly
- Executes all reads at a timestamp >=
min_read_timestamp. - TransactionOptions_ReadOnly::setMaxStaleness() — Method in class TransactionOptions_ReadOnly
- Read data at a timestamp >=
NOW - max_stalenessseconds. Guarantees that all writes that have committed more than the specified number of seconds ago are visible. Because Cloud Spanner chooses the exact timestamp, this mode works even if the client's local clock is substantially skewed from Cloud Spanner commit timestamps. - TransactionOptions_ReadOnly::setReadTimestamp() — Method in class TransactionOptions_ReadOnly
- Executes all reads at the given timestamp. Unlike other modes, reads at a specific timestamp are repeatable; the same read at the same timestamp always returns the same data. If the timestamp is in the future, the read will block until the specified timestamp, modulo the read's deadline.
- TransactionOptions_ReadOnly::setExactStaleness() — Method in class TransactionOptions_ReadOnly
- Executes all reads at a timestamp that is
exact_stalenessold. The timestamp is chosen soon after the read is started. - TransactionOptions_ReadOnly::setReturnReadTimestamp() — Method in class TransactionOptions_ReadOnly
- If true, the Cloud Spanner-selected read timestamp is included in the [Transaction][google.spanner.v1.Transaction] message that describes the transaction.
- $TransactionSelector#selector — Property in class TransactionSelector
- TransactionSelector::setSingleUse() — Method in class TransactionSelector
- Execute the read or SQL query in a temporary transaction.
- TransactionSelector::setId() — Method in class TransactionSelector
- Execute the read or SQL query in a previously-started transaction.
- TransactionSelector::setBegin() — Method in class TransactionSelector
- Begin a new transaction and execute this read or SQL query in it. The transaction ID of the new transaction is returned in [ResultSetMetadata.transaction][google.spanner.v1.ResultSetMetadata.transaction], which is a [Transaction][google.spanner.v1.Transaction].
- Type::setCode() — Method in class Type
- Required. The [TypeCode][google.spanner.v1.TypeCode] for this type.
- Type::setArrayElementType() — Method in class Type
- If [code][google.spanner.v1.Type.code] == [ARRAY][google.spanner.v1.TypeCode.ARRAY], then
array_element_typeis the type of the array elements. - Type::setStructType() — Method in class Type
- If [code][google.spanner.v1.Type.code] == [STRUCT][google.spanner.v1.TypeCode.STRUCT], then
struct_typeprovides type information for the struct's fields. - LongRunningRecognizeMetadata::setProgressPercent() — Method in class LongRunningRecognizeMetadata
- Approximate percentage of audio processed thus far. Guaranteed to be 100 when the audio is fully processed and the results are available.
- LongRunningRecognizeMetadata::setStartTime() — Method in class LongRunningRecognizeMetadata
- Time when the request was received.
- LongRunningRecognizeMetadata::setLastUpdateTime() — Method in class LongRunningRecognizeMetadata
- Time of the most recent processing update.
- LongRunningRecognizeRequest::setConfig() — Method in class LongRunningRecognizeRequest
- Required Provides information to the recognizer that specifies how to process the request.
- LongRunningRecognizeRequest::setAudio() — Method in class LongRunningRecognizeRequest
- Required The audio data to be recognized.
- LongRunningRecognizeResponse::setResults() — Method in class LongRunningRecognizeResponse
- Output-only Sequential list of transcription results corresponding to sequential portions of audio.
- RecognitionAudio::setContent() — Method in class RecognitionAudio
- The audio data bytes encoded as specified in
RecognitionConfig. Note: as with all bytes fields, protobuffers use a pure binary representation, whereas JSON representations use base64. - RecognitionAudio::setUri() — Method in class RecognitionAudio
- URI that points to a file that contains audio data bytes as specified in
RecognitionConfig. Currently, only Google Cloud Storage URIs are supported, which must be specified in the following format:gs://bucket_name/object_name(other URI formats return [google.rpc.Code.INVALID_ARGUMENT][google.rpc.Code.INVALID_ARGUMENT]). For more information, see Request URIs. - RecognitionConfig::setEncoding() — Method in class RecognitionConfig
- Required Encoding of audio data sent in all
RecognitionAudiomessages. - RecognitionConfig::setSampleRateHertz() — Method in class RecognitionConfig
- Required Sample rate in Hertz of the audio data sent in all
RecognitionAudiomessages. Valid values are: 8000-48000. - RecognitionConfig::setLanguageCode() — Method in class RecognitionConfig
- Required The language of the supplied audio as a BCP-47 language tag.
- RecognitionConfig::setMaxAlternatives() — Method in class RecognitionConfig
- Optional Maximum number of recognition hypotheses to be returned.
- RecognitionConfig::setProfanityFilter() — Method in class RecognitionConfig
- Optional If set to
true, the server will attempt to filter out profanities, replacing all but the initial character in each filtered word with asterisks, e.g. "f***". If set tofalseor omitted, profanities won't be filtered out. - RecognitionConfig::setSpeechContexts() — Method in class RecognitionConfig
- Optional A means to provide context to assist the speech recognition.
- RecognitionConfig::setEnableWordTimeOffsets() — Method in class RecognitionConfig
- Optional If
true, the top result includes a list of words and the start and end time offsets (timestamps) for those words. Iffalse, no word-level time offset information is returned. The default isfalse. - RecognizeRequest::setConfig() — Method in class RecognizeRequest
- Required Provides information to the recognizer that specifies how to process the request.
- RecognizeRequest::setAudio() — Method in class RecognizeRequest
- Required The audio data to be recognized.
- RecognizeResponse::setResults() — Method in class RecognizeResponse
- Output-only Sequential list of transcription results corresponding to sequential portions of audio.
- SpeechContext — Class in namespace Google\Cloud\Speech\V1
- Provides "hints" to the speech recognizer to favor specific words and phrases in the results.
- SpeechContext::setPhrases() — Method in class SpeechContext
- Optional A list of strings containing words and phrases "hints" so that the speech recognition is more likely to recognize them. This can be used to improve the accuracy for specific words and phrases, for example, if specific commands are typically spoken by the user. This can also be used to add additional words to the vocabulary of the recognizer. See usage limits.
- SpeechGrpcClient — Class in namespace Google\Cloud\Speech\V1
- Service that implements Google Cloud Speech API.
- SpeechGrpcClient::StreamingRecognize() — Method in class SpeechGrpcClient
- Performs bidirectional streaming speech recognition: receive results while sending audio. This method is only available via the gRPC API (not REST).
- SpeechRecognitionAlternative — Class in namespace Google\Cloud\Speech\V1
- Alternative hypotheses (a.k.a. n-best list).
- SpeechRecognitionAlternative::setTranscript() — Method in class SpeechRecognitionAlternative
- Output-only Transcript text representing the words that the user spoke.
- SpeechRecognitionAlternative::setConfidence() — Method in class SpeechRecognitionAlternative
- Output-only The confidence estimate between 0.0 and 1.0. A higher number
indicates an estimated greater likelihood that the recognized words are
correct. This field is typically provided only for the top hypothesis, and
only for
is_final=trueresults. Clients should not rely on theconfidencefield as it is not guaranteed to be accurate or consistent. - SpeechRecognitionAlternative::setWords() — Method in class SpeechRecognitionAlternative
- Output-only A list of word-specific information for each recognized word.
- SpeechRecognitionResult — Class in namespace Google\Cloud\Speech\V1
- A speech recognition result corresponding to a portion of the audio.
- SpeechRecognitionResult::setAlternatives() — Method in class SpeechRecognitionResult
- Output-only May contain one or more recognition hypotheses (up to the
maximum specified in
max_alternatives). - StreamingRecognitionConfig — Class in namespace Google\Cloud\Speech\V1
- Provides information to the recognizer that specifies how to process the request.
- StreamingRecognitionConfig::setConfig() — Method in class StreamingRecognitionConfig
- Required Provides information to the recognizer that specifies how to process the request.
- StreamingRecognitionConfig::setSingleUtterance() — Method in class StreamingRecognitionConfig
- Optional If
falseor omitted, the recognizer will perform continuous recognition (continuing to wait for and process audio even if the user pauses speaking) until the client closes the input stream (gRPC API) or until the maximum time limit has been reached. May return multipleStreamingRecognitionResults with theis_finalflag set totrue. - StreamingRecognitionConfig::setInterimResults() — Method in class StreamingRecognitionConfig
- Optional If
true, interim results (tentative hypotheses) may be returned as they become available (these interim results are indicated with theis_final=falseflag). - StreamingRecognitionResult — Class in namespace Google\Cloud\Speech\V1
- A streaming speech recognition result corresponding to a portion of the audio that is currently being processed.
- StreamingRecognitionResult::setAlternatives() — Method in class StreamingRecognitionResult
- Output-only May contain one or more recognition hypotheses (up to the
maximum specified in
max_alternatives). - StreamingRecognitionResult::setIsFinal() — Method in class StreamingRecognitionResult
- Output-only If
false, thisStreamingRecognitionResultrepresents an interim result that may change. Iftrue, this is the final time the speech service will return this particularStreamingRecognitionResult, the recognizer will not return any further hypotheses for this portion of the transcript and corresponding audio. - StreamingRecognitionResult::setStability() — Method in class StreamingRecognitionResult
- Output-only An estimate of the likelihood that the recognizer will not change its guess about this interim result. Values range from 0.0 (completely unstable) to 1.0 (completely stable).
- StreamingRecognizeRequest — Class in namespace Google\Cloud\Speech\V1
- The top-level message sent by the client for the
StreamingRecognizemethod. - $StreamingRecognizeRequest#streaming_request — Property in class StreamingRecognizeRequest
- StreamingRecognizeRequest::setStreamingConfig() — Method in class StreamingRecognizeRequest
- Provides information to the recognizer that specifies how to process the
request. The first
StreamingRecognizeRequestmessage must contain astreaming_configmessage. - StreamingRecognizeRequest::setAudioContent() — Method in class StreamingRecognizeRequest
- The audio data to be recognized. Sequential chunks of audio data are sent
in sequential
StreamingRecognizeRequestmessages. The firstStreamingRecognizeRequestmessage must not containaudio_contentdata and all subsequentStreamingRecognizeRequestmessages must containaudio_contentdata. The audio bytes must be encoded as specified inRecognitionConfig. Note: as with all bytes fields, protobuffers use a pure binary representation (not base64). See audio limits. - StreamingRecognizeResponse — Class in namespace Google\Cloud\Speech\V1
StreamingRecognizeResponseis the only message returned to the client byStreamingRecognize. A series of zero or moreStreamingRecognizeResponsemessages are streamed back to the client. If there is no recognizable audio, andsingle_utteranceis set to false, then no messages are streamed back to the client.- StreamingRecognizeResponse::setError() — Method in class StreamingRecognizeResponse
- Output-only If set, returns a [google.rpc.Status][google.rpc.Status] message that specifies the error for the operation.
- StreamingRecognizeResponse::setResults() — Method in class StreamingRecognizeResponse
- Output-only This repeated list contains zero or more results that correspond to consecutive portions of the audio currently being processed.
- StreamingRecognizeResponse::setSpeechEventType() — Method in class StreamingRecognizeResponse
- Output-only Indicates the type of speech event.
- StreamingRecognizeResponse_SpeechEventType — Class in namespace Google\Cloud\Speech\V1
- Indicates the type of speech event.
- WordInfo::setStartTime() — Method in class WordInfo
- Output-only Time offset relative to the beginning of the audio, and corresponding to the start of the spoken word.
- WordInfo::setEndTime() — Method in class WordInfo
- Output-only Time offset relative to the beginning of the audio, and corresponding to the end of the spoken word.
- WordInfo::setWord() — Method in class WordInfo
- Output-only The word corresponding to this set of information.
- AsyncRecognizeMetadata::setProgressPercent() — Method in class AsyncRecognizeMetadata
- Approximate percentage of audio processed thus far. Guaranteed to be 100 when the audio is fully processed and the results are available.
- AsyncRecognizeMetadata::setStartTime() — Method in class AsyncRecognizeMetadata
- Time when the request was received.
- AsyncRecognizeMetadata::setLastUpdateTime() — Method in class AsyncRecognizeMetadata
- Time of the most recent processing update.
- AsyncRecognizeRequest::setConfig() — Method in class AsyncRecognizeRequest
- Required Provides information to the recognizer that specifies how to process the request.
- AsyncRecognizeRequest::setAudio() — Method in class AsyncRecognizeRequest
- Required The audio data to be recognized.
- AsyncRecognizeResponse::setResults() — Method in class AsyncRecognizeResponse
- Output-only Sequential list of transcription results corresponding to sequential portions of audio.
- RecognitionAudio::setContent() — Method in class RecognitionAudio
- The audio data bytes encoded as specified in
RecognitionConfig. Note: as with all bytes fields, protobuffers use a pure binary representation, whereas JSON representations use base64. - RecognitionAudio::setUri() — Method in class RecognitionAudio
- URI that points to a file that contains audio data bytes as specified in
RecognitionConfig. Currently, only Google Cloud Storage URIs are supported, which must be specified in the following format:gs://bucket_name/object_name(other URI formats return [google.rpc.Code.INVALID_ARGUMENT][google.rpc.Code.INVALID_ARGUMENT]). For more information, see Request URIs. - RecognitionConfig::setEncoding() — Method in class RecognitionConfig
- Required Encoding of audio data sent in all
RecognitionAudiomessages. - RecognitionConfig::setSampleRate() — Method in class RecognitionConfig
- Required Sample rate in Hertz of the audio data sent in all
RecognitionAudiomessages. Valid values are: 8000-48000. - RecognitionConfig::setLanguageCode() — Method in class RecognitionConfig
- Optional The language of the supplied audio as a BCP-47 language tag.
- RecognitionConfig::setMaxAlternatives() — Method in class RecognitionConfig
- Optional Maximum number of recognition hypotheses to be returned.
- RecognitionConfig::setProfanityFilter() — Method in class RecognitionConfig
- Optional If set to
true, the server will attempt to filter out profanities, replacing all but the initial character in each filtered word with asterisks, e.g. "f***". If set tofalseor omitted, profanities won't be filtered out. - RecognitionConfig::setSpeechContext() — Method in class RecognitionConfig
- Optional A means to provide context to assist the speech recognition.
- SpeechContext — Class in namespace Google\Cloud\Speech\V1beta1
- Provides "hints" to the speech recognizer to favor specific words and phrases in the results.
- SpeechContext::setPhrases() — Method in class SpeechContext
- Optional A list of strings containing words and phrases "hints" so that the speech recognition is more likely to recognize them. This can be used to improve the accuracy for specific words and phrases, for example, if specific commands are typically spoken by the user. This can also be used to add additional words to the vocabulary of the recognizer. See usage limits.
- SpeechGrpcClient — Class in namespace Google\Cloud\Speech\V1beta1
- Service that implements Google Cloud Speech API.
- SpeechGrpcClient::SyncRecognize() — Method in class SpeechGrpcClient
- Performs synchronous speech recognition: receive results after all audio has been sent and processed.
- SpeechGrpcClient::StreamingRecognize() — Method in class SpeechGrpcClient
- Performs bidirectional streaming speech recognition: receive results while sending audio. This method is only available via the gRPC API (not REST).
- SpeechRecognitionAlternative — Class in namespace Google\Cloud\Speech\V1beta1
- Alternative hypotheses (a.k.a. n-best list).
- SpeechRecognitionAlternative::setTranscript() — Method in class SpeechRecognitionAlternative
- Output-only Transcript text representing the words that the user spoke.
- SpeechRecognitionAlternative::setConfidence() — Method in class SpeechRecognitionAlternative
- Output-only The confidence estimate between 0.0 and 1.0. A higher number
indicates an estimated greater likelihood that the recognized words are
correct. This field is typically provided only for the top hypothesis, and
only for
is_final=trueresults. Clients should not rely on theconfidencefield as it is not guaranteed to be accurate, or even set, in any of the results. - SpeechRecognitionResult — Class in namespace Google\Cloud\Speech\V1beta1
- A speech recognition result corresponding to a portion of the audio.
- SpeechRecognitionResult::setAlternatives() — Method in class SpeechRecognitionResult
- Output-only May contain one or more recognition hypotheses (up to the
maximum specified in
max_alternatives). - StreamingRecognitionConfig — Class in namespace Google\Cloud\Speech\V1beta1
- Provides information to the recognizer that specifies how to process the request.
- StreamingRecognitionConfig::setConfig() — Method in class StreamingRecognitionConfig
- Required Provides information to the recognizer that specifies how to process the request.
- StreamingRecognitionConfig::setSingleUtterance() — Method in class StreamingRecognitionConfig
- Optional If
falseor omitted, the recognizer will perform continuous recognition (continuing to wait for and process audio even if the user pauses speaking) until the client closes the input stream (gRPC API) or until the maximum time limit has been reached. May return multipleStreamingRecognitionResults with theis_finalflag set totrue. - StreamingRecognitionConfig::setInterimResults() — Method in class StreamingRecognitionConfig
- Optional If
true, interim results (tentative hypotheses) may be returned as they become available (these interim results are indicated with theis_final=falseflag). - StreamingRecognitionResult — Class in namespace Google\Cloud\Speech\V1beta1
- A streaming speech recognition result corresponding to a portion of the audio that is currently being processed.
- StreamingRecognitionResult::setAlternatives() — Method in class StreamingRecognitionResult
- Output-only May contain one or more recognition hypotheses (up to the
maximum specified in
max_alternatives). - StreamingRecognitionResult::setIsFinal() — Method in class StreamingRecognitionResult
- Output-only If
false, thisStreamingRecognitionResultrepresents an interim result that may change. Iftrue, this is the final time the speech service will return this particularStreamingRecognitionResult, the recognizer will not return any further hypotheses for this portion of the transcript and corresponding audio. - StreamingRecognitionResult::setStability() — Method in class StreamingRecognitionResult
- Output-only An estimate of the likelihood that the recognizer will not change its guess about this interim result. Values range from 0.0 (completely unstable) to 1.0 (completely stable).
- StreamingRecognizeRequest — Class in namespace Google\Cloud\Speech\V1beta1
- The top-level message sent by the client for the
StreamingRecognizemethod. - $StreamingRecognizeRequest#streaming_request — Property in class StreamingRecognizeRequest
- StreamingRecognizeRequest::setStreamingConfig() — Method in class StreamingRecognizeRequest
- Provides information to the recognizer that specifies how to process the
request. The first
StreamingRecognizeRequestmessage must contain astreaming_configmessage. - StreamingRecognizeRequest::setAudioContent() — Method in class StreamingRecognizeRequest
- The audio data to be recognized. Sequential chunks of audio data are sent
in sequential
StreamingRecognizeRequestmessages. The firstStreamingRecognizeRequestmessage must not containaudio_contentdata and all subsequentStreamingRecognizeRequestmessages must containaudio_contentdata. The audio bytes must be encoded as specified inRecognitionConfig. Note: as with all bytes fields, protobuffers use a pure binary representation (not base64). See audio limits. - StreamingRecognizeResponse — Class in namespace Google\Cloud\Speech\V1beta1
StreamingRecognizeResponseis the only message returned to the client byStreamingRecognize. A series of one or moreStreamingRecognizeResponsemessages are streamed back to the client.- StreamingRecognizeResponse::setError() — Method in class StreamingRecognizeResponse
- Output-only If set, returns a [google.rpc.Status][google.rpc.Status] message that specifies the error for the operation.
- StreamingRecognizeResponse::setResults() — Method in class StreamingRecognizeResponse
- Output-only This repeated list contains zero or more results that correspond to consecutive portions of the audio currently being processed.
- StreamingRecognizeResponse::setResultIndex() — Method in class StreamingRecognizeResponse
- Output-only Indicates the lowest index in the
resultsarray that has changed. The repeatedStreamingRecognitionResultresults overwrite past results at this index and higher. - StreamingRecognizeResponse::setEndpointerType() — Method in class StreamingRecognizeResponse
- Output-only Indicates the type of endpointer event.
- StreamingRecognizeResponse_EndpointerType — Class in namespace Google\Cloud\Speech\V1beta1
- Indicates the type of endpointer event.
- SyncRecognizeRequest — Class in namespace Google\Cloud\Speech\V1beta1
- The top-level message sent by the client for the
SyncRecognizemethod. - SyncRecognizeRequest::setConfig() — Method in class SyncRecognizeRequest
- Required Provides information to the recognizer that specifies how to process the request.
- SyncRecognizeRequest::setAudio() — Method in class SyncRecognizeRequest
- Required The audio data to be recognized.
- SyncRecognizeResponse — Class in namespace Google\Cloud\Speech\V1beta1
- The only message returned to the client by
SyncRecognize. method. It contains the result as zero or more sequentialSpeechRecognitionResultmessages. - SyncRecognizeResponse::setResults() — Method in class SyncRecognizeResponse
- Output-only Sequential list of transcription results corresponding to sequential portions of audio.
- LongRunningRecognizeMetadata::setProgressPercent() — Method in class LongRunningRecognizeMetadata
- Approximate percentage of audio processed thus far. Guaranteed to be 100 when the audio is fully processed and the results are available.
- LongRunningRecognizeMetadata::setStartTime() — Method in class LongRunningRecognizeMetadata
- Time when the request was received.
- LongRunningRecognizeMetadata::setLastUpdateTime() — Method in class LongRunningRecognizeMetadata
- Time of the most recent processing update.
- LongRunningRecognizeRequest::setConfig() — Method in class LongRunningRecognizeRequest
- Required Provides information to the recognizer that specifies how to process the request.
- LongRunningRecognizeRequest::setAudio() — Method in class LongRunningRecognizeRequest
- Required The audio data to be recognized.
- LongRunningRecognizeResponse::setResults() — Method in class LongRunningRecognizeResponse
- Output only. Sequential list of transcription results corresponding to sequential portions of audio.
- RecognitionAudio::setContent() — Method in class RecognitionAudio
- The audio data bytes encoded as specified in
RecognitionConfig. Note: as with all bytes fields, protobuffers use a pure binary representation, whereas JSON representations use base64. - RecognitionAudio::setUri() — Method in class RecognitionAudio
- URI that points to a file that contains audio data bytes as specified in
RecognitionConfig. Currently, only Google Cloud Storage URIs are supported, which must be specified in the following format:gs://bucket_name/object_name(other URI formats return [google.rpc.Code.INVALID_ARGUMENT][google.rpc.Code.INVALID_ARGUMENT]). For more information, see Request URIs. - RecognitionConfig::setEncoding() — Method in class RecognitionConfig
- Encoding of audio data sent in all
RecognitionAudiomessages. - RecognitionConfig::setSampleRateHertz() — Method in class RecognitionConfig
- Sample rate in Hertz of the audio data sent in all
RecognitionAudiomessages. Valid values are: 8000-48000. - RecognitionConfig::setAudioChannelCount() — Method in class RecognitionConfig
- Optional The number of channels in the input audio data.
- RecognitionConfig::setEnableSeparateRecognitionPerChannel() — Method in class RecognitionConfig
- This needs to be set to ‘true’ explicitly and audio_channel_count > 1 to get each channel recognized separately. The recognition result will contain a channel_tag field to state which channel that result belongs to.
- RecognitionConfig::setLanguageCode() — Method in class RecognitionConfig
- Required The language of the supplied audio as a BCP-47 language tag.
- RecognitionConfig::setAlternativeLanguageCodes() — Method in class RecognitionConfig
- Optional A list of up to 3 additional BCP-47 language tags, listing possible alternative languages of the supplied audio.
- RecognitionConfig::setMaxAlternatives() — Method in class RecognitionConfig
- Optional Maximum number of recognition hypotheses to be returned.
- RecognitionConfig::setProfanityFilter() — Method in class RecognitionConfig
- Optional If set to
true, the server will attempt to filter out profanities, replacing all but the initial character in each filtered word with asterisks, e.g. "f***". If set tofalseor omitted, profanities won't be filtered out. - RecognitionConfig::setSpeechContexts() — Method in class RecognitionConfig
- Optional A means to provide context to assist the speech recognition.
- RecognitionConfig::setEnableWordTimeOffsets() — Method in class RecognitionConfig
- Optional If
true, the top result includes a list of words and the start and end time offsets (timestamps) for those words. Iffalse, no word-level time offset information is returned. The default isfalse. - RecognitionConfig::setEnableWordConfidence() — Method in class RecognitionConfig
- Optional If
true, the top result includes a list of words and the confidence for those words. Iffalse, no word-level confidence information is returned. The default isfalse. - RecognitionConfig::setEnableAutomaticPunctuation() — Method in class RecognitionConfig
- Optional If 'true', adds punctuation to recognition result hypotheses.
- RecognitionConfig::setEnableSpeakerDiarization() — Method in class RecognitionConfig
- Optional If 'true', enables speaker detection for each recognized word in the top alternative of the recognition result using a speaker_tag provided in the WordInfo.
- RecognitionConfig::setDiarizationSpeakerCount() — Method in class RecognitionConfig
- Optional If set, specifies the estimated number of speakers in the conversation.
- RecognitionConfig::setMetadata() — Method in class RecognitionConfig
- Optional Metadata regarding this request.
- RecognitionConfig::setModel() — Method in class RecognitionConfig
- Optional Which model to select for the given request. Select the model best suited to your domain to get best results. If a model is not explicitly specified, then we auto-select a model based on the parameters in the RecognitionConfig.
- RecognitionConfig::setUseEnhanced() — Method in class RecognitionConfig
- Optional Set to true to use an enhanced model for speech recognition.
- RecognitionMetadata::setInteractionType() — Method in class RecognitionMetadata
- The use case most closely describing the audio content to be recognized.
- RecognitionMetadata::setIndustryNaicsCodeOfAudio() — Method in class RecognitionMetadata
- The industry vertical to which this speech recognition request most closely applies. This is most indicative of the topics contained in the audio. Use the 6-digit NAICS code to identify the industry vertical - see https://www.naics.com/search/.
- RecognitionMetadata::setMicrophoneDistance() — Method in class RecognitionMetadata
- The audio type that most closely describes the audio being recognized.
- RecognitionMetadata::setOriginalMediaType() — Method in class RecognitionMetadata
- The original media the speech was recorded on.
- RecognitionMetadata::setRecordingDeviceType() — Method in class RecognitionMetadata
- The type of device the speech was recorded with.
- RecognitionMetadata::setRecordingDeviceName() — Method in class RecognitionMetadata
- The device used to make the recording. Examples 'Nexus 5X' or 'Polycom SoundStation IP 6000' or 'POTS' or 'VoIP' or 'Cardioid Microphone'.
- RecognitionMetadata::setOriginalMimeType() — Method in class RecognitionMetadata
- Mime type of the original audio file. For example
audio/m4a,audio/x-alaw-basic,audio/mp3,audio/3gpp. - RecognitionMetadata::setObfuscatedId() — Method in class RecognitionMetadata
- Obfuscated (privacy-protected) ID of the user, to identify number of unique users using the service.
- RecognitionMetadata::setAudioTopic() — Method in class RecognitionMetadata
- Description of the content. Eg. "Recordings of federal supreme court hearings from 2012".
- RecognizeRequest::setConfig() — Method in class RecognizeRequest
- Required Provides information to the recognizer that specifies how to process the request.
- RecognizeRequest::setAudio() — Method in class RecognizeRequest
- Required The audio data to be recognized.
- RecognizeResponse::setResults() — Method in class RecognizeResponse
- Output only. Sequential list of transcription results corresponding to sequential portions of audio.
- SpeechContext — Class in namespace Google\Cloud\Speech\V1p1beta1
- Provides "hints" to the speech recognizer to favor specific words and phrases in the results.
- SpeechContext::setPhrases() — Method in class SpeechContext
- Optional A list of strings containing words and phrases "hints" so that the speech recognition is more likely to recognize them. This can be used to improve the accuracy for specific words and phrases, for example, if specific commands are typically spoken by the user. This can also be used to add additional words to the vocabulary of the recognizer. See usage limits.
- SpeechGrpcClient — Class in namespace Google\Cloud\Speech\V1p1beta1
- Service that implements Google Cloud Speech API.
- SpeechGrpcClient::StreamingRecognize() — Method in class SpeechGrpcClient
- Performs bidirectional streaming speech recognition: receive results while sending audio. This method is only available via the gRPC API (not REST).
- SpeechRecognitionAlternative — Class in namespace Google\Cloud\Speech\V1p1beta1
- Alternative hypotheses (a.k.a. n-best list).
- SpeechRecognitionAlternative::setTranscript() — Method in class SpeechRecognitionAlternative
- Output only. Transcript text representing the words that the user spoke.
- SpeechRecognitionAlternative::setConfidence() — Method in class SpeechRecognitionAlternative
- Output only. The confidence estimate between 0.0 and 1.0. A higher number
indicates an estimated greater likelihood that the recognized words are
correct. This field is set only for the top alternative of a non-streaming
result or, of a streaming result where
is_final=true. - SpeechRecognitionAlternative::setWords() — Method in class SpeechRecognitionAlternative
- Output only. A list of word-specific information for each recognized word.
- SpeechRecognitionResult — Class in namespace Google\Cloud\Speech\V1p1beta1
- A speech recognition result corresponding to a portion of the audio.
- SpeechRecognitionResult::setAlternatives() — Method in class SpeechRecognitionResult
- Output only. May contain one or more recognition hypotheses (up to the
maximum specified in
max_alternatives). - SpeechRecognitionResult::setChannelTag() — Method in class SpeechRecognitionResult
- For multi-channel audio, this is the channel number corresponding to the recognized result for the audio from that channel.
- SpeechRecognitionResult::setLanguageCode() — Method in class SpeechRecognitionResult
- Output only. The BCP-47 language tag of the language in this result. This language code was detected to have the most likelihood of being spoken in the audio.
- StreamingRecognitionConfig — Class in namespace Google\Cloud\Speech\V1p1beta1
- Provides information to the recognizer that specifies how to process the request.
- StreamingRecognitionConfig::setConfig() — Method in class StreamingRecognitionConfig
- Required Provides information to the recognizer that specifies how to process the request.
- StreamingRecognitionConfig::setSingleUtterance() — Method in class StreamingRecognitionConfig
- Optional If
falseor omitted, the recognizer will perform continuous recognition (continuing to wait for and process audio even if the user pauses speaking) until the client closes the input stream (gRPC API) or until the maximum time limit has been reached. May return multipleStreamingRecognitionResults with theis_finalflag set totrue. - StreamingRecognitionConfig::setInterimResults() — Method in class StreamingRecognitionConfig
- Optional If
true, interim results (tentative hypotheses) may be returned as they become available (these interim results are indicated with theis_final=falseflag). - StreamingRecognitionResult — Class in namespace Google\Cloud\Speech\V1p1beta1
- A streaming speech recognition result corresponding to a portion of the audio that is currently being processed.
- StreamingRecognitionResult::setAlternatives() — Method in class StreamingRecognitionResult
- Output only. May contain one or more recognition hypotheses (up to the
maximum specified in
max_alternatives). - StreamingRecognitionResult::setIsFinal() — Method in class StreamingRecognitionResult
- Output only. If
false, thisStreamingRecognitionResultrepresents an interim result that may change. Iftrue, this is the final time the speech service will return this particularStreamingRecognitionResult, the recognizer will not return any further hypotheses for this portion of the transcript and corresponding audio. - StreamingRecognitionResult::setStability() — Method in class StreamingRecognitionResult
- Output only. An estimate of the likelihood that the recognizer will not change its guess about this interim result. Values range from 0.0 (completely unstable) to 1.0 (completely stable).
- StreamingRecognitionResult::setChannelTag() — Method in class StreamingRecognitionResult
- For multi-channel audio, this is the channel number corresponding to the recognized result for the audio from that channel.
- StreamingRecognitionResult::setLanguageCode() — Method in class StreamingRecognitionResult
- Output only. The BCP-47 language tag of the language in this result. This language code was detected to have the most likelihood of being spoken in the audio.
- StreamingRecognizeRequest — Class in namespace Google\Cloud\Speech\V1p1beta1
- The top-level message sent by the client for the
StreamingRecognizemethod. - $StreamingRecognizeRequest#streaming_request — Property in class StreamingRecognizeRequest
- StreamingRecognizeRequest::setStreamingConfig() — Method in class StreamingRecognizeRequest
- Provides information to the recognizer that specifies how to process the
request. The first
StreamingRecognizeRequestmessage must contain astreaming_configmessage. - StreamingRecognizeRequest::setAudioContent() — Method in class StreamingRecognizeRequest
- The audio data to be recognized. Sequential chunks of audio data are sent
in sequential
StreamingRecognizeRequestmessages. The firstStreamingRecognizeRequestmessage must not containaudio_contentdata and all subsequentStreamingRecognizeRequestmessages must containaudio_contentdata. The audio bytes must be encoded as specified inRecognitionConfig. Note: as with all bytes fields, protobuffers use a pure binary representation (not base64). See audio limits. - StreamingRecognizeResponse — Class in namespace Google\Cloud\Speech\V1p1beta1
StreamingRecognizeResponseis the only message returned to the client byStreamingRecognize. A series of zero or moreStreamingRecognizeResponsemessages are streamed back to the client. If there is no recognizable audio, andsingle_utteranceis set to false, then no messages are streamed back to the client.- StreamingRecognizeResponse::setError() — Method in class StreamingRecognizeResponse
- Output only. If set, returns a [google.rpc.Status][google.rpc.Status] message that specifies the error for the operation.
- StreamingRecognizeResponse::setResults() — Method in class StreamingRecognizeResponse
- Output only. This repeated list contains zero or more results that correspond to consecutive portions of the audio currently being processed.
- StreamingRecognizeResponse::setSpeechEventType() — Method in class StreamingRecognizeResponse
- Output only. Indicates the type of speech event.
- StreamingRecognizeResponse_SpeechEventType — Class in namespace Google\Cloud\Speech\V1p1beta1
- Indicates the type of speech event.
- WordInfo::setStartTime() — Method in class WordInfo
- Output only. Time offset relative to the beginning of the audio, and corresponding to the start of the spoken word.
- WordInfo::setEndTime() — Method in class WordInfo
- Output only. Time offset relative to the beginning of the audio, and corresponding to the end of the spoken word.
- WordInfo::setWord() — Method in class WordInfo
- Output only. The word corresponding to this set of information.
- WordInfo::setConfidence() — Method in class WordInfo
- Output only. The confidence estimate between 0.0 and 1.0. A higher number
indicates an estimated greater likelihood that the recognized words are
correct. This field is set only for the top alternative of a non-streaming
result or, of a streaming result where
is_final=true. - WordInfo::setSpeakerTag() — Method in class WordInfo
- Output only. A distinct integer value is assigned for every speaker within the audio. This field specifies which one of those speakers was detected to have spoken this word. Value ranges from '1' to diarization_speaker_count.
- AcknowledgeTaskRequest::setName() — Method in class AcknowledgeTaskRequest
- Required.
- AcknowledgeTaskRequest::setScheduleTime() — Method in class AcknowledgeTaskRequest
- Required.
- AppEngineHttpRequest::setHttpMethod() — Method in class AppEngineHttpRequest
- The HTTP method to use for the request. The default is POST.
- AppEngineHttpRequest::setAppEngineRouting() — Method in class AppEngineHttpRequest
- Task-level setting for App Engine routing.
- AppEngineHttpRequest::setRelativeUrl() — Method in class AppEngineHttpRequest
- The relative URL.
- AppEngineHttpRequest::setHeaders() — Method in class AppEngineHttpRequest
- HTTP request headers.
- AppEngineHttpRequest::setPayload() — Method in class AppEngineHttpRequest
- Payload.
- AppEngineHttpTarget::setAppEngineRoutingOverride() — Method in class AppEngineHttpTarget
- Overrides for the [task-level app_engine_routing][google.cloud.tasks.v2beta2.AppEngineHttpRequest.app_engine_routing].
- AppEngineRouting::setService() — Method in class AppEngineRouting
- App service.
- AppEngineRouting::setVersion() — Method in class AppEngineRouting
- App version.
- AppEngineRouting::setInstance() — Method in class AppEngineRouting
- App instance.
- AppEngineRouting::setHost() — Method in class AppEngineRouting
- Output only. The host that the task is sent to.
- AttemptStatus::setScheduleTime() — Method in class AttemptStatus
- Output only. The time that this attempt was scheduled.
- AttemptStatus::setDispatchTime() — Method in class AttemptStatus
- Output only. The time that this attempt was dispatched.
- AttemptStatus::setResponseTime() — Method in class AttemptStatus
- Output only. The time that this attempt response was received.
- AttemptStatus::setResponseStatus() — Method in class AttemptStatus
- Output only. The response from the target for this attempt.
- CancelLeaseRequest::setName() — Method in class CancelLeaseRequest
- Required.
- CancelLeaseRequest::setScheduleTime() — Method in class CancelLeaseRequest
- Required.
- CancelLeaseRequest::setResponseView() — Method in class CancelLeaseRequest
- The response_view specifies which subset of the [Task][google.cloud.tasks.v2beta2.Task] will be returned.
- CloudTasksGrpcClient::SetIamPolicy() — Method in class CloudTasksGrpcClient
- Sets the access control policy for a [Queue][google.cloud.tasks.v2beta2.Queue]. Replaces any existing policy.
- CreateQueueRequest::setParent() — Method in class CreateQueueRequest
- Required.
- CreateQueueRequest::setQueue() — Method in class CreateQueueRequest
- Required.
- CreateTaskRequest::setParent() — Method in class CreateTaskRequest
- Required.
- CreateTaskRequest::setTask() — Method in class CreateTaskRequest
- Required.
- CreateTaskRequest::setResponseView() — Method in class CreateTaskRequest
- The response_view specifies which subset of the [Task][google.cloud.tasks.v2beta2.Task] will be returned.
- DeleteQueueRequest::setName() — Method in class DeleteQueueRequest
- Required.
- DeleteTaskRequest::setName() — Method in class DeleteTaskRequest
- Required.
- GetQueueRequest::setName() — Method in class GetQueueRequest
- Required.
- GetTaskRequest::setName() — Method in class GetTaskRequest
- Required.
- GetTaskRequest::setResponseView() — Method in class GetTaskRequest
- The response_view specifies which subset of the [Task][google.cloud.tasks.v2beta2.Task] will be returned.
- LeaseTasksRequest::setParent() — Method in class LeaseTasksRequest
- Required.
- LeaseTasksRequest::setMaxTasks() — Method in class LeaseTasksRequest
- The maximum number of tasks to lease. The maximum that can be requested is 1000.
- LeaseTasksRequest::setLeaseDuration() — Method in class LeaseTasksRequest
- After the worker has successfully finished the work associated with the task, the worker must call via [AcknowledgeTask][google.cloud.tasks.v2beta2.CloudTasks.AcknowledgeTask] before the [schedule_time][google.cloud.tasks.v2beta2.Task.schedule_time]. Otherwise the task will be returned to a later [LeaseTasks][google.cloud.tasks.v2beta2.CloudTasks.LeaseTasks] call so that another worker can retry it.
- LeaseTasksRequest::setResponseView() — Method in class LeaseTasksRequest
- The response_view specifies which subset of the [Task][google.cloud.tasks.v2beta2.Task] will be returned.
- LeaseTasksRequest::setFilter() — Method in class LeaseTasksRequest
filtercan be used to specify a subset of tasks to lease.- LeaseTasksResponse::setTasks() — Method in class LeaseTasksResponse
- The leased tasks.
- ListQueuesRequest::setParent() — Method in class ListQueuesRequest
- Required.
- ListQueuesRequest::setFilter() — Method in class ListQueuesRequest
filtercan be used to specify a subset of queues. Any [Queue][google.cloud.tasks.v2beta2.Queue] field can be used as a filter and several operators as supported.- ListQueuesRequest::setPageSize() — Method in class ListQueuesRequest
- Requested page size.
- ListQueuesRequest::setPageToken() — Method in class ListQueuesRequest
- A token identifying the page of results to return.
- ListQueuesResponse::setQueues() — Method in class ListQueuesResponse
- The list of queues.
- ListQueuesResponse::setNextPageToken() — Method in class ListQueuesResponse
- A token to retrieve next page of results.
- ListTasksRequest::setParent() — Method in class ListTasksRequest
- Required.
- ListTasksRequest::setResponseView() — Method in class ListTasksRequest
- The response_view specifies which subset of the [Task][google.cloud.tasks.v2beta2.Task] will be returned.
- ListTasksRequest::setOrderBy() — Method in class ListTasksRequest
- Sort order used for the query. The only fields supported for sorting
are
schedule_timeandpull_message.tag. All results will be returned in approximately ascending order. The default ordering is byschedule_time. - ListTasksRequest::setPageSize() — Method in class ListTasksRequest
- Requested page size. Fewer tasks than requested might be returned.
- ListTasksRequest::setPageToken() — Method in class ListTasksRequest
- A token identifying the page of results to return.
- ListTasksResponse::setTasks() — Method in class ListTasksResponse
- The list of tasks.
- ListTasksResponse::setNextPageToken() — Method in class ListTasksResponse
- A token to retrieve next page of results.
- PauseQueueRequest::setName() — Method in class PauseQueueRequest
- Required.
- PullMessage::setPayload() — Method in class PullMessage
- A data payload consumed by the worker to execute the task.
- PullMessage::setTag() — Method in class PullMessage
- The task's tag.
- PurgeQueueRequest::setName() — Method in class PurgeQueueRequest
- Required.
- Queue::setName() — Method in class Queue
- The queue name.
- Queue::setAppEngineHttpTarget() — Method in class Queue
- App Engine HTTP target.
- Queue::setPullTarget() — Method in class Queue
- Pull target.
- Queue::setRateLimits() — Method in class Queue
- Rate limits for task dispatches.
- Queue::setRetryConfig() — Method in class Queue
- Settings that determine the retry behavior.
- Queue::setState() — Method in class Queue
- Output only. The state of the queue.
- Queue::setPurgeTime() — Method in class Queue
- Output only. The last time this queue was purged.
- RateLimits::setMaxTasksDispatchedPerSecond() — Method in class RateLimits
- The maximum rate at which tasks are dispatched from this queue.
- RateLimits::setMaxBurstSize() — Method in class RateLimits
- Output only. The max burst size.
- RateLimits::setMaxConcurrentTasks() — Method in class RateLimits
- The maximum number of concurrent tasks that Cloud Tasks allows to be dispatched for this queue. After this threshold has been reached, Cloud Tasks stops dispatching tasks until the number of concurrent requests decreases.
- RenewLeaseRequest::setName() — Method in class RenewLeaseRequest
- Required.
- RenewLeaseRequest::setScheduleTime() — Method in class RenewLeaseRequest
- Required.
- RenewLeaseRequest::setLeaseDuration() — Method in class RenewLeaseRequest
- Required.
- RenewLeaseRequest::setResponseView() — Method in class RenewLeaseRequest
- The response_view specifies which subset of the [Task][google.cloud.tasks.v2beta2.Task] will be returned.
- ResumeQueueRequest::setName() — Method in class ResumeQueueRequest
- Required.
- RetryConfig::setMaxAttempts() — Method in class RetryConfig
- The maximum number of attempts for a task.
- RetryConfig::setUnlimitedAttempts() — Method in class RetryConfig
- If true, then the number of attempts is unlimited.
- RetryConfig::setMaxRetryDuration() — Method in class RetryConfig
- If positive,
max_retry_durationspecifies the time limit for retrying a failed task, measured from when the task was first attempted. Oncemax_retry_durationtime has passed and the task has been attempted [max_attempts][google.cloud.tasks.v2beta2.RetryConfig.max_attempts] times, no further attempts will be made and the task will be deleted. - RetryConfig::setMinBackoff() — Method in class RetryConfig
- A task will be scheduled for retry between [min_backoff][google.cloud.tasks.v2beta2.RetryConfig.min_backoff] and [max_backoff][google.cloud.tasks.v2beta2.RetryConfig.max_backoff] duration after it fails, if the queue's [RetryConfig][google.cloud.tasks.v2beta2.RetryConfig] specifies that the task should be retried.
- RetryConfig::setMaxBackoff() — Method in class RetryConfig
- A task will be scheduled for retry between [min_backoff][google.cloud.tasks.v2beta2.RetryConfig.min_backoff] and [max_backoff][google.cloud.tasks.v2beta2.RetryConfig.max_backoff] duration after it fails, if the queue's [RetryConfig][google.cloud.tasks.v2beta2.RetryConfig] specifies that the task should be retried.
- RetryConfig::setMaxDoublings() — Method in class RetryConfig
- The time between retries will double
max_doublingstimes. - RunTaskRequest::setName() — Method in class RunTaskRequest
- Required.
- RunTaskRequest::setResponseView() — Method in class RunTaskRequest
- The response_view specifies which subset of the [Task][google.cloud.tasks.v2beta2.Task] will be returned.
- Task::setName() — Method in class Task
- The task name.
- Task::setAppEngineHttpRequest() — Method in class Task
- App Engine HTTP request that is sent to the task's target. Can be set only if [app_engine_http_target][google.cloud.tasks.v2beta2.Queue.app_engine_http_target] is set on the queue.
- Task::setPullMessage() — Method in class Task
- [LeaseTasks][google.cloud.tasks.v2beta2.CloudTasks.LeaseTasks] to process the task. Can be set only if [pull_target][google.cloud.tasks.v2beta2.Queue.pull_target] is set on the queue.
- Task::setScheduleTime() — Method in class Task
- The time when the task is scheduled to be attempted.
- Task::setCreateTime() — Method in class Task
- Output only. The time that the task was created.
- Task::setStatus() — Method in class Task
- Output only. The task status.
- Task::setView() — Method in class Task
- Output only. The view specifies which subset of the [Task][google.cloud.tasks.v2beta2.Task] has been returned.
- TaskStatus::setAttemptDispatchCount() — Method in class TaskStatus
- Output only. The number of attempts dispatched.
- TaskStatus::setAttemptResponseCount() — Method in class TaskStatus
- Output only. The number of attempts which have received a response.
- TaskStatus::setFirstAttemptStatus() — Method in class TaskStatus
- Output only. The status of the task's first attempt.
- TaskStatus::setLastAttemptStatus() — Method in class TaskStatus
- Output only. The status of the task's last attempt.
- UpdateQueueRequest::setQueue() — Method in class UpdateQueueRequest
- Required.
- UpdateQueueRequest::setUpdateMask() — Method in class UpdateQueueRequest
- A mask used to specify which fields of the queue are being updated.
- AttributeValue::setStringValue() — Method in class AttributeValue
- A string up to 256 bytes long.
- AttributeValue::setIntValue() — Method in class AttributeValue
- A 64-bit signed integer.
- AttributeValue::setBoolValue() — Method in class AttributeValue
- A Boolean value represented by
trueorfalse. - BatchWriteSpansRequest::setName() — Method in class BatchWriteSpansRequest
- Required. The name of the project where the spans belong. The format is
projects/[PROJECT_ID]. - BatchWriteSpansRequest::setSpans() — Method in class BatchWriteSpansRequest
- A list of new spans. The span names must not match existing spans, or the results are undefined.
- Module::setModule() — Method in class Module
- For example: main binary, kernel modules, and dynamic libraries such as libc.so, sharedlib.so (up to 256 bytes).
- Module::setBuildId() — Method in class Module
- A unique identifier for the module, usually a hash of its contents (up to 128 bytes).
- Span — Class in namespace Google\Cloud\Trace\V2
- A span represents a single operation within a trace. Spans can be nested to form a trace tree. Often, a trace contains a root span that describes the end-to-end latency, and one or more subspans for its sub-operations. A trace can also contain multiple root spans, or none at all. Spans do not need to be contiguous—there may be gaps or overlaps between spans in a trace.
- Span::setName() — Method in class Span
- The resource name of the span in the following format: projects/[PROJECT_ID]/traces/[TRACE_ID]/spans/[SPAN_ID] [TRACE_ID] is a unique identifier for a trace within a project; it is a 32-character hexadecimal encoding of a 16-byte array.
- Span::setSpanId() — Method in class Span
- The [SPAN_ID] portion of the span's resource name.
- Span::setParentSpanId() — Method in class Span
- The [SPAN_ID] of this span's parent span. If this is a root span, then this field must be empty.
- Span::setDisplayName() — Method in class Span
- A description of the span's operation (up to 128 bytes).
- Span::setStartTime() — Method in class Span
- The start time of the span. On the client side, this is the time kept by the local machine where the span execution starts. On the server side, this is the time when the server's application handler starts running.
- Span::setEndTime() — Method in class Span
- The end time of the span. On the client side, this is the time kept by the local machine where the span execution ends. On the server side, this is the time when the server application handler stops running.
- Span::setAttributes() — Method in class Span
- A set of attributes on the span. You can have up to 32 attributes per span.
- Span::setStackTrace() — Method in class Span
- Stack trace captured at the start of the span.
- Span::setTimeEvents() — Method in class Span
- A set of time events. You can have up to 32 annotations and 128 message events per span.
- Span::setLinks() — Method in class Span
- Links associated with the span. You can have up to 128 links per Span.
- Span::setStatus() — Method in class Span
- An optional final status for this span.
- Span::setSameProcessAsParentSpan() — Method in class Span
- (Optional) Set this parameter to indicate whether this span is in the same process as its parent. If you do not set this parameter, Stackdriver Trace is unable to take advantage of this helpful information.
- Span::setChildSpanCount() — Method in class Span
- An optional number of child spans that were generated while this span was active. If set, allows implementation to detect missing child spans.
- Span_Attributes — Class in namespace Google\Cloud\Trace\V2
- A set of attributes, each in the format
[KEY]:[VALUE]. - Span_Attributes::setAttributeMap() — Method in class Span_Attributes
- The set of attributes. Each attribute's key can be up to 128 bytes
long. The value can be a string up to 256 bytes, an integer, or the
Boolean values
trueandfalse. For example: "/instance_id": "my-instance" "/http/user_agent": "" "/http/request_bytes": 300 "abc.com/myattribute": true - Span_Attributes::setDroppedAttributesCount() — Method in class Span_Attributes
- The number of attributes that were discarded. Attributes can be discarded because their keys are too long or because there are too many attributes.
- Span_Link — Class in namespace Google\Cloud\Trace\V2
- A pointer from the current span to another span in the same trace or in a different trace. For example, this can be used in batching operations, where a single batch handler processes multiple requests from different traces or when the handler receives a request from a different project.
- Span_Link::setTraceId() — Method in class Span_Link
- The [TRACE_ID] for a trace within a project.
- Span_Link::setSpanId() — Method in class Span_Link
- The [SPAN_ID] for a span within a trace.
- Span_Link::setType() — Method in class Span_Link
- The relationship of the current span relative to the linked span.
- Span_Link::setAttributes() — Method in class Span_Link
- A set of attributes on the link. You have have up to 32 attributes per link.
- Span_Link_Type — Class in namespace Google\Cloud\Trace\V2
- The relationship of the current span relative to the linked span: child, parent, or unspecified.
- Span_Links — Class in namespace Google\Cloud\Trace\V2
- A collection of links, which are references from this span to a span in the same or different trace.
- Span_Links::setLink() — Method in class Span_Links
- A collection of links.
- Span_Links::setDroppedLinksCount() — Method in class Span_Links
- The number of dropped links after the maximum size was enforced. If this value is 0, then no links were dropped.
- Span_TimeEvent — Class in namespace Google\Cloud\Trace\V2
- A time-stamped annotation or message event in the Span.
- Span_TimeEvent::setTime() — Method in class Span_TimeEvent
- The timestamp indicating the time the event occurred.
- Span_TimeEvent::setAnnotation() — Method in class Span_TimeEvent
- Text annotation with a set of attributes.
- Span_TimeEvent::setMessageEvent() — Method in class Span_TimeEvent
- An event describing a message sent/received between Spans.
- Span_TimeEvent_Annotation — Class in namespace Google\Cloud\Trace\V2
- Text annotation with a set of attributes.
- Span_TimeEvent_Annotation::setDescription() — Method in class Span_TimeEvent_Annotation
- A user-supplied message describing the event. The maximum length for the description is 256 bytes.
- Span_TimeEvent_Annotation::setAttributes() — Method in class Span_TimeEvent_Annotation
- A set of attributes on the annotation. You can have up to 4 attributes per Annotation.
- Span_TimeEvent_MessageEvent — Class in namespace Google\Cloud\Trace\V2
- An event describing a message sent/received between Spans.
- Span_TimeEvent_MessageEvent::setType() — Method in class Span_TimeEvent_MessageEvent
- Type of MessageEvent. Indicates whether the message was sent or received.
- Span_TimeEvent_MessageEvent::setId() — Method in class Span_TimeEvent_MessageEvent
- An identifier for the MessageEvent's message that can be used to match SENT and RECEIVED MessageEvents. It is recommended to be unique within a Span.
- Span_TimeEvent_MessageEvent::setUncompressedSizeBytes() — Method in class Span_TimeEvent_MessageEvent
- The number of uncompressed bytes sent or received.
- Span_TimeEvent_MessageEvent::setCompressedSizeBytes() — Method in class Span_TimeEvent_MessageEvent
- The number of compressed bytes sent or received. If missing assumed to be the same size as uncompressed.
- Span_TimeEvent_MessageEvent_Type — Class in namespace Google\Cloud\Trace\V2
- Indicates whether the message was sent or received.
- Span_TimeEvents — Class in namespace Google\Cloud\Trace\V2
- A collection of
TimeEvents. ATimeEventis a time-stamped annotation on the span, consisting of either user-supplied key:value pairs, or details of a message sent/received between Spans. - Span_TimeEvents::setTimeEvent() — Method in class Span_TimeEvents
- A collection of
TimeEvents. - Span_TimeEvents::setDroppedAnnotationsCount() — Method in class Span_TimeEvents
- The number of dropped annotations in all the included time events.
- Span_TimeEvents::setDroppedMessageEventsCount() — Method in class Span_TimeEvents
- The number of dropped message events in all the included time events.
- StackTrace — Class in namespace Google\Cloud\Trace\V2
- A call stack appearing in a trace.
- StackTrace::setStackFrames() — Method in class StackTrace
- Stack frames in this stack trace. A maximum of 128 frames are allowed.
- StackTrace::setStackTraceHashId() — Method in class StackTrace
- The hash ID is used to conserve network bandwidth for duplicate stack traces within a single trace.
- StackTrace_StackFrame — Class in namespace Google\Cloud\Trace\V2
- Represents a single stack frame in a stack trace.
- StackTrace_StackFrame::setFunctionName() — Method in class StackTrace_StackFrame
- The fully-qualified name that uniquely identifies the function or method that is active in this frame (up to 1024 bytes).
- StackTrace_StackFrame::setOriginalFunctionName() — Method in class StackTrace_StackFrame
- An un-mangled function name, if
function_nameis mangled. The name can be fully-qualified (up to 1024 bytes). - StackTrace_StackFrame::setFileName() — Method in class StackTrace_StackFrame
- The name of the source file where the function call appears (up to 256 bytes).
- StackTrace_StackFrame::setLineNumber() — Method in class StackTrace_StackFrame
- The line number in
file_namewhere the function call appears. - StackTrace_StackFrame::setColumnNumber() — Method in class StackTrace_StackFrame
- The column number where the function call appears, if available.
- StackTrace_StackFrame::setLoadModule() — Method in class StackTrace_StackFrame
- The binary module from where the code was loaded.
- StackTrace_StackFrame::setSourceVersion() — Method in class StackTrace_StackFrame
- The version of the deployed source code (up to 128 bytes).
- StackTrace_StackFrames — Class in namespace Google\Cloud\Trace\V2
- A collection of stack frames, which can be truncated.
- StackTrace_StackFrames::setFrame() — Method in class StackTrace_StackFrames
- Stack frames in this call stack.
- StackTrace_StackFrames::setDroppedFramesCount() — Method in class StackTrace_StackFrames
- The number of stack frames that were dropped because there were too many stack frames.
- TruncatableString::setValue() — Method in class TruncatableString
- The shortened string. For example, if the original string is 500
bytes long and the limit of the string is 128 bytes, then
valuecontains the first 128 bytes of the 500-byte string. - TruncatableString::setTruncatedByteCount() — Method in class TruncatableString
- The number of bytes removed from the original string. If this value is 0, then the string was not shortened.
- AnnotateVideoProgress::setAnnotationProgress() — Method in class AnnotateVideoProgress
- Progress metadata for all videos specified in
AnnotateVideoRequest. - AnnotateVideoRequest::setInputUri() — Method in class AnnotateVideoRequest
- Input video location. Currently, only
Google Cloud Storage URIs are
supported, which must be specified in the following format:
gs://bucket-id/object-id(other URI formats return [google.rpc.Code.INVALID_ARGUMENT][google.rpc.Code.INVALID_ARGUMENT]). For more information, see Request URIs. - AnnotateVideoRequest::setInputContent() — Method in class AnnotateVideoRequest
- The video data bytes.
- AnnotateVideoRequest::setFeatures() — Method in class AnnotateVideoRequest
- Requested video annotation features.
- AnnotateVideoRequest::setVideoContext() — Method in class AnnotateVideoRequest
- Additional video context and/or feature-specific parameters.
- AnnotateVideoRequest::setOutputUri() — Method in class AnnotateVideoRequest
- Optional location where the output (in JSON format) should be stored.
- AnnotateVideoRequest::setLocationId() — Method in class AnnotateVideoRequest
- Optional cloud region where annotation should take place. Supported cloud
regions:
us-east1,us-west1,europe-west1,asia-east1. If no region is specified, a region will be determined based on video file location. - AnnotateVideoResponse::setAnnotationResults() — Method in class AnnotateVideoResponse
- Annotation results for all videos specified in
AnnotateVideoRequest. - Entity::setEntityId() — Method in class Entity
- Opaque entity ID. Some IDs may be available in Google Knowledge Graph Search API.
- Entity::setDescription() — Method in class Entity
- Textual description, e.g.
Fixed-gear bicycle. - Entity::setLanguageCode() — Method in class Entity
- Language code for
descriptionin BCP-47 format. - ExplicitContentAnnotation::setFrames() — Method in class ExplicitContentAnnotation
- All video frames where explicit content was detected.
- ExplicitContentDetectionConfig::setModel() — Method in class ExplicitContentDetectionConfig
- Model to use for explicit content detection.
- ExplicitContentFrame::setTimeOffset() — Method in class ExplicitContentFrame
- Time-offset, relative to the beginning of the video, corresponding to the video frame for this location.
- ExplicitContentFrame::setPornographyLikelihood() — Method in class ExplicitContentFrame
- Likelihood of the pornography content.
- FaceAnnotation::setThumbnail() — Method in class FaceAnnotation
- Thumbnail of a representative face view (in JPEG format).
- FaceAnnotation::setSegments() — Method in class FaceAnnotation
- All video segments where a face was detected.
- FaceAnnotation::setFrames() — Method in class FaceAnnotation
- All video frames where a face was detected.
- FaceDetectionConfig::setModel() — Method in class FaceDetectionConfig
- Model to use for face detection.
- FaceDetectionConfig::setIncludeBoundingBoxes() — Method in class FaceDetectionConfig
- Whether bounding boxes be included in the face annotation output.
- FaceFrame::setNormalizedBoundingBoxes() — Method in class FaceFrame
- Normalized Bounding boxes in a frame.
- FaceFrame::setTimeOffset() — Method in class FaceFrame
- Time-offset, relative to the beginning of the video, corresponding to the video frame for this location.
- FaceSegment::setSegment() — Method in class FaceSegment
- Video segment where a face was detected.
- LabelAnnotation::setEntity() — Method in class LabelAnnotation
- Detected entity.
- LabelAnnotation::setCategoryEntities() — Method in class LabelAnnotation
- Common categories for the detected entity.
- LabelAnnotation::setSegments() — Method in class LabelAnnotation
- All video segments where a label was detected.
- LabelAnnotation::setFrames() — Method in class LabelAnnotation
- All video frames where a label was detected.
- LabelDetectionConfig::setLabelDetectionMode() — Method in class LabelDetectionConfig
- What labels should be detected with LABEL_DETECTION, in addition to video-level labels or segment-level labels.
- LabelDetectionConfig::setStationaryCamera() — Method in class LabelDetectionConfig
- Whether the video has been shot from a stationary (i.e. non-moving) camera.
- LabelDetectionConfig::setModel() — Method in class LabelDetectionConfig
- Model to use for label detection.
- LabelFrame::setTimeOffset() — Method in class LabelFrame
- Time-offset, relative to the beginning of the video, corresponding to the video frame for this location.
- LabelFrame::setConfidence() — Method in class LabelFrame
- Confidence that the label is accurate. Range: [0, 1].
- LabelSegment::setSegment() — Method in class LabelSegment
- Video segment where a label was detected.
- LabelSegment::setConfidence() — Method in class LabelSegment
- Confidence that the label is accurate. Range: [0, 1].
- NormalizedBoundingBox::setLeft() — Method in class NormalizedBoundingBox
- Left X coordinate.
- NormalizedBoundingBox::setTop() — Method in class NormalizedBoundingBox
- Top Y coordinate.
- NormalizedBoundingBox::setRight() — Method in class NormalizedBoundingBox
- Right X coordinate.
- NormalizedBoundingBox::setBottom() — Method in class NormalizedBoundingBox
- Bottom Y coordinate.
- ShotChangeDetectionConfig — Class in namespace Google\Cloud\VideoIntelligence\V1
- Config for SHOT_CHANGE_DETECTION.
- ShotChangeDetectionConfig::setModel() — Method in class ShotChangeDetectionConfig
- Model to use for shot change detection.
- VideoAnnotationProgress::setInputUri() — Method in class VideoAnnotationProgress
- Video file location in Google Cloud Storage.
- VideoAnnotationProgress::setProgressPercent() — Method in class VideoAnnotationProgress
- Approximate percentage processed thus far.
- VideoAnnotationProgress::setStartTime() — Method in class VideoAnnotationProgress
- Time when the request was received.
- VideoAnnotationProgress::setUpdateTime() — Method in class VideoAnnotationProgress
- Time of the most recent update.
- VideoAnnotationResults::setInputUri() — Method in class VideoAnnotationResults
- Video file location in Google Cloud Storage.
- VideoAnnotationResults::setSegmentLabelAnnotations() — Method in class VideoAnnotationResults
- Label annotations on video level or user specified segment level.
- VideoAnnotationResults::setShotLabelAnnotations() — Method in class VideoAnnotationResults
- Label annotations on shot level.
- VideoAnnotationResults::setFrameLabelAnnotations() — Method in class VideoAnnotationResults
- Label annotations on frame level.
- VideoAnnotationResults::setFaceAnnotations() — Method in class VideoAnnotationResults
- Face annotations. There is exactly one element for each unique face.
- VideoAnnotationResults::setShotAnnotations() — Method in class VideoAnnotationResults
- Shot annotations. Each shot is represented as a video segment.
- VideoAnnotationResults::setExplicitAnnotation() — Method in class VideoAnnotationResults
- Explicit content annotation.
- VideoAnnotationResults::setError() — Method in class VideoAnnotationResults
- If set, indicates an error. Note that for a single
AnnotateVideoRequestsome videos may succeed and some may fail. - VideoContext::setSegments() — Method in class VideoContext
- Video segments to annotate. The segments may overlap and are not required to be contiguous or span the whole video. If unspecified, each video is treated as a single segment.
- VideoContext::setLabelDetectionConfig() — Method in class VideoContext
- Config for LABEL_DETECTION.
- VideoContext::setShotChangeDetectionConfig() — Method in class VideoContext
- Config for SHOT_CHANGE_DETECTION.
- VideoContext::setExplicitContentDetectionConfig() — Method in class VideoContext
- Config for EXPLICIT_CONTENT_DETECTION.
- VideoContext::setFaceDetectionConfig() — Method in class VideoContext
- Config for FACE_DETECTION.
- VideoSegment::setStartTimeOffset() — Method in class VideoSegment
- Time-offset, relative to the beginning of the video, corresponding to the start of the segment (inclusive).
- VideoSegment::setEndTimeOffset() — Method in class VideoSegment
- Time-offset, relative to the beginning of the video, corresponding to the end of the segment (inclusive).
- AnnotateVideoProgress::setAnnotationProgress() — Method in class AnnotateVideoProgress
- Progress metadata for all videos specified in
AnnotateVideoRequest. - AnnotateVideoRequest::setInputUri() — Method in class AnnotateVideoRequest
- Input video location. Currently, only
Google Cloud Storage URIs are
supported, which must be specified in the following format:
gs://bucket-id/object-id(other URI formats return [google.rpc.Code.INVALID_ARGUMENT][google.rpc.Code.INVALID_ARGUMENT]). For more information, see Request URIs. - AnnotateVideoRequest::setInputContent() — Method in class AnnotateVideoRequest
- The video data bytes. Encoding: base64. If unset, the input video(s)
should be specified via
input_uri. If set,input_urishould be unset. - AnnotateVideoRequest::setFeatures() — Method in class AnnotateVideoRequest
- Requested video annotation features.
- AnnotateVideoRequest::setVideoContext() — Method in class AnnotateVideoRequest
- Additional video context and/or feature-specific parameters.
- AnnotateVideoRequest::setOutputUri() — Method in class AnnotateVideoRequest
- Optional location where the output (in JSON format) should be stored.
- AnnotateVideoRequest::setLocationId() — Method in class AnnotateVideoRequest
- Optional cloud region where annotation should take place. Supported cloud
regions:
us-east1,us-west1,europe-west1,asia-east1. If no region is specified, a region will be determined based on video file location. - AnnotateVideoResponse::setAnnotationResults() — Method in class AnnotateVideoResponse
- Annotation results for all videos specified in
AnnotateVideoRequest. - BoundingBox::setLeft() — Method in class BoundingBox
- Left X coordinate.
- BoundingBox::setRight() — Method in class BoundingBox
- Right X coordinate.
- BoundingBox::setBottom() — Method in class BoundingBox
- Bottom Y coordinate.
- BoundingBox::setTop() — Method in class BoundingBox
- Top Y coordinate.
- FaceAnnotation::setThumbnail() — Method in class FaceAnnotation
- Thumbnail of a representative face view (in JPEG format). Encoding: base64.
- FaceAnnotation::setSegments() — Method in class FaceAnnotation
- All locations where a face was detected.
- FaceAnnotation::setLocations() — Method in class FaceAnnotation
- Face locations at one frame per second.
- FaceLocation::setBoundingBox() — Method in class FaceLocation
- Bounding box in a frame.
- FaceLocation::setTimeOffset() — Method in class FaceLocation
- Video time offset in microseconds.
- LabelAnnotation::setDescription() — Method in class LabelAnnotation
- Textual description, e.g.
Fixed-gear bicycle. - LabelAnnotation::setLanguageCode() — Method in class LabelAnnotation
- Language code for
descriptionin BCP-47 format. - LabelAnnotation::setLocations() — Method in class LabelAnnotation
- Where the label was detected and with what confidence.
- LabelLocation::setSegment() — Method in class LabelLocation
- Video segment. Set to [-1, -1] for video-level labels.
- LabelLocation::setConfidence() — Method in class LabelLocation
- Confidence that the label is accurate. Range: [0, 1].
- LabelLocation::setLevel() — Method in class LabelLocation
- Label level.
- SafeSearchAnnotation — Class in namespace Google\Cloud\VideoIntelligence\V1beta1
- Safe search annotation (based on per-frame visual signals only).
- SafeSearchAnnotation::setAdult() — Method in class SafeSearchAnnotation
- Likelihood of adult content.
- SafeSearchAnnotation::setSpoof() — Method in class SafeSearchAnnotation
- Likelihood that an obvious modification was made to the original version to make it appear funny or offensive.
- SafeSearchAnnotation::setMedical() — Method in class SafeSearchAnnotation
- Likelihood of medical content.
- SafeSearchAnnotation::setViolent() — Method in class SafeSearchAnnotation
- Likelihood of violent content.
- SafeSearchAnnotation::setRacy() — Method in class SafeSearchAnnotation
- Likelihood of racy content.
- SafeSearchAnnotation::setTimeOffset() — Method in class SafeSearchAnnotation
- Video time offset in microseconds.
- VideoAnnotationProgress::setInputUri() — Method in class VideoAnnotationProgress
- Video file location in Google Cloud Storage.
- VideoAnnotationProgress::setProgressPercent() — Method in class VideoAnnotationProgress
- Approximate percentage processed thus far.
- VideoAnnotationProgress::setStartTime() — Method in class VideoAnnotationProgress
- Time when the request was received.
- VideoAnnotationProgress::setUpdateTime() — Method in class VideoAnnotationProgress
- Time of the most recent update.
- VideoAnnotationResults::setInputUri() — Method in class VideoAnnotationResults
- Video file location in Google Cloud Storage.
- VideoAnnotationResults::setLabelAnnotations() — Method in class VideoAnnotationResults
- Label annotations. There is exactly one element for each unique label.
- VideoAnnotationResults::setFaceAnnotations() — Method in class VideoAnnotationResults
- Face annotations. There is exactly one element for each unique face.
- VideoAnnotationResults::setShotAnnotations() — Method in class VideoAnnotationResults
- Shot annotations. Each shot is represented as a video segment.
- VideoAnnotationResults::setSafeSearchAnnotations() — Method in class VideoAnnotationResults
- Safe search annotations.
- VideoAnnotationResults::setError() — Method in class VideoAnnotationResults
- If set, indicates an error. Note that for a single
AnnotateVideoRequestsome videos may succeed and some may fail. - VideoContext::setSegments() — Method in class VideoContext
- Video segments to annotate. The segments may overlap and are not required to be contiguous or span the whole video. If unspecified, each video is treated as a single segment.
- VideoContext::setLabelDetectionMode() — Method in class VideoContext
- If label detection has been requested, what labels should be detected
in addition to video-level labels or segment-level labels. If unspecified,
defaults to
SHOT_MODE. - VideoContext::setStationaryCamera() — Method in class VideoContext
- Whether the video has been shot from a stationary (i.e. non-moving) camera.
- VideoContext::setLabelDetectionModel() — Method in class VideoContext
- Model to use for label detection.
- VideoContext::setFaceDetectionModel() — Method in class VideoContext
- Model to use for face detection.
- VideoContext::setShotChangeDetectionModel() — Method in class VideoContext
- Model to use for shot change detection.
- VideoContext::setSafeSearchDetectionModel() — Method in class VideoContext
- Model to use for safe search detection.
- VideoSegment::setStartTimeOffset() — Method in class VideoSegment
- Start offset in microseconds (inclusive). Unset means 0.
- VideoSegment::setEndTimeOffset() — Method in class VideoSegment
- End offset in microseconds (inclusive). Unset means 0.
- AnnotateVideoProgress::setAnnotationProgress() — Method in class AnnotateVideoProgress
- Progress metadata for all videos specified in
AnnotateVideoRequest. - AnnotateVideoRequest::setInputUri() — Method in class AnnotateVideoRequest
- Input video location. Currently, only
Google Cloud Storage URIs are
supported, which must be specified in the following format:
gs://bucket-id/object-id(other URI formats return [google.rpc.Code.INVALID_ARGUMENT][google.rpc.Code.INVALID_ARGUMENT]). For more information, see Request URIs. - AnnotateVideoRequest::setInputContent() — Method in class AnnotateVideoRequest
- The video data bytes.
- AnnotateVideoRequest::setFeatures() — Method in class AnnotateVideoRequest
- Requested video annotation features.
- AnnotateVideoRequest::setVideoContext() — Method in class AnnotateVideoRequest
- Additional video context and/or feature-specific parameters.
- AnnotateVideoRequest::setOutputUri() — Method in class AnnotateVideoRequest
- Optional location where the output (in JSON format) should be stored.
- AnnotateVideoRequest::setLocationId() — Method in class AnnotateVideoRequest
- Optional cloud region where annotation should take place. Supported cloud
regions:
us-east1,us-west1,europe-west1,asia-east1. If no region is specified, a region will be determined based on video file location. - AnnotateVideoResponse::setAnnotationResults() — Method in class AnnotateVideoResponse
- Annotation results for all videos specified in
AnnotateVideoRequest. - Entity::setEntityId() — Method in class Entity
- Opaque entity ID. Some IDs may be available in Google Knowledge Graph Search API.
- Entity::setDescription() — Method in class Entity
- Textual description, e.g.
Fixed-gear bicycle. - Entity::setLanguageCode() — Method in class Entity
- Language code for
descriptionin BCP-47 format. - ExplicitContentAnnotation::setFrames() — Method in class ExplicitContentAnnotation
- All video frames where explicit content was detected.
- ExplicitContentDetectionConfig::setModel() — Method in class ExplicitContentDetectionConfig
- Model to use for explicit content detection.
- ExplicitContentFrame::setTimeOffset() — Method in class ExplicitContentFrame
- Time-offset, relative to the beginning of the video, corresponding to the video frame for this location.
- ExplicitContentFrame::setPornographyLikelihood() — Method in class ExplicitContentFrame
- Likelihood of the pornography content.
- FaceAnnotation::setThumbnail() — Method in class FaceAnnotation
- Thumbnail of a representative face view (in JPEG format).
- FaceAnnotation::setSegments() — Method in class FaceAnnotation
- All video segments where a face was detected.
- FaceAnnotation::setFrames() — Method in class FaceAnnotation
- All video frames where a face was detected.
- FaceDetectionConfig::setModel() — Method in class FaceDetectionConfig
- Model to use for face detection.
- FaceDetectionConfig::setIncludeBoundingBoxes() — Method in class FaceDetectionConfig
- Whether bounding boxes be included in the face annotation output.
- FaceFrame::setNormalizedBoundingBoxes() — Method in class FaceFrame
- Normalized Bounding boxes in a frame.
- FaceFrame::setTimeOffset() — Method in class FaceFrame
- Time-offset, relative to the beginning of the video, corresponding to the video frame for this location.
- FaceSegment::setSegment() — Method in class FaceSegment
- Video segment where a face was detected.
- LabelAnnotation::setEntity() — Method in class LabelAnnotation
- Detected entity.
- LabelAnnotation::setCategoryEntities() — Method in class LabelAnnotation
- Common categories for the detected entity.
- LabelAnnotation::setSegments() — Method in class LabelAnnotation
- All video segments where a label was detected.
- LabelAnnotation::setFrames() — Method in class LabelAnnotation
- All video frames where a label was detected.
- LabelDetectionConfig::setLabelDetectionMode() — Method in class LabelDetectionConfig
- What labels should be detected with LABEL_DETECTION, in addition to video-level labels or segment-level labels.
- LabelDetectionConfig::setStationaryCamera() — Method in class LabelDetectionConfig
- Whether the video has been shot from a stationary (i.e. non-moving) camera.
- LabelDetectionConfig::setModel() — Method in class LabelDetectionConfig
- Model to use for label detection.
- LabelFrame::setTimeOffset() — Method in class LabelFrame
- Time-offset, relative to the beginning of the video, corresponding to the video frame for this location.
- LabelFrame::setConfidence() — Method in class LabelFrame
- Confidence that the label is accurate. Range: [0, 1].
- LabelSegment::setSegment() — Method in class LabelSegment
- Video segment where a label was detected.
- LabelSegment::setConfidence() — Method in class LabelSegment
- Confidence that the label is accurate. Range: [0, 1].
- NormalizedBoundingBox::setLeft() — Method in class NormalizedBoundingBox
- Left X coordinate.
- NormalizedBoundingBox::setTop() — Method in class NormalizedBoundingBox
- Top Y coordinate.
- NormalizedBoundingBox::setRight() — Method in class NormalizedBoundingBox
- Right X coordinate.
- NormalizedBoundingBox::setBottom() — Method in class NormalizedBoundingBox
- Bottom Y coordinate.
- ShotChangeDetectionConfig — Class in namespace Google\Cloud\VideoIntelligence\V1beta2
- Config for SHOT_CHANGE_DETECTION.
- ShotChangeDetectionConfig::setModel() — Method in class ShotChangeDetectionConfig
- Model to use for shot change detection.
- VideoAnnotationProgress::setInputUri() — Method in class VideoAnnotationProgress
- Video file location in Google Cloud Storage.
- VideoAnnotationProgress::setProgressPercent() — Method in class VideoAnnotationProgress
- Approximate percentage processed thus far.
- VideoAnnotationProgress::setStartTime() — Method in class VideoAnnotationProgress
- Time when the request was received.
- VideoAnnotationProgress::setUpdateTime() — Method in class VideoAnnotationProgress
- Time of the most recent update.
- VideoAnnotationResults::setInputUri() — Method in class VideoAnnotationResults
- Video file location in Google Cloud Storage.
- VideoAnnotationResults::setSegmentLabelAnnotations() — Method in class VideoAnnotationResults
- Label annotations on video level or user specified segment level.
- VideoAnnotationResults::setShotLabelAnnotations() — Method in class VideoAnnotationResults
- Label annotations on shot level.
- VideoAnnotationResults::setFrameLabelAnnotations() — Method in class VideoAnnotationResults
- Label annotations on frame level.
- VideoAnnotationResults::setFaceAnnotations() — Method in class VideoAnnotationResults
- Face annotations. There is exactly one element for each unique face.
- VideoAnnotationResults::setShotAnnotations() — Method in class VideoAnnotationResults
- Shot annotations. Each shot is represented as a video segment.
- VideoAnnotationResults::setExplicitAnnotation() — Method in class VideoAnnotationResults
- Explicit content annotation.
- VideoAnnotationResults::setError() — Method in class VideoAnnotationResults
- If set, indicates an error. Note that for a single
AnnotateVideoRequestsome videos may succeed and some may fail. - VideoContext::setSegments() — Method in class VideoContext
- Video segments to annotate. The segments may overlap and are not required to be contiguous or span the whole video. If unspecified, each video is treated as a single segment.
- VideoContext::setLabelDetectionConfig() — Method in class VideoContext
- Config for LABEL_DETECTION.
- VideoContext::setShotChangeDetectionConfig() — Method in class VideoContext
- Config for SHOT_CHANGE_DETECTION.
- VideoContext::setExplicitContentDetectionConfig() — Method in class VideoContext
- Config for EXPLICIT_CONTENT_DETECTION.
- VideoContext::setFaceDetectionConfig() — Method in class VideoContext
- Config for FACE_DETECTION.
- VideoSegment::setStartTimeOffset() — Method in class VideoSegment
- Time-offset, relative to the beginning of the video, corresponding to the start of the segment (inclusive).
- VideoSegment::setEndTimeOffset() — Method in class VideoSegment
- Time-offset, relative to the beginning of the video, corresponding to the end of the segment (inclusive).
- AnnotateFileResponse::setInputConfig() — Method in class AnnotateFileResponse
- Information about the file for which this response is generated.
- AnnotateFileResponse::setResponses() — Method in class AnnotateFileResponse
- Individual responses to images found within the file.
- AnnotateImageRequest::setImage() — Method in class AnnotateImageRequest
- The image to be processed.
- AnnotateImageRequest::setFeatures() — Method in class AnnotateImageRequest
- Requested features.
- AnnotateImageRequest::setImageContext() — Method in class AnnotateImageRequest
- Additional context that may accompany the image.
- AnnotateImageResponse::setFaceAnnotations() — Method in class AnnotateImageResponse
- If present, face detection has completed successfully.
- AnnotateImageResponse::setLandmarkAnnotations() — Method in class AnnotateImageResponse
- If present, landmark detection has completed successfully.
- AnnotateImageResponse::setLogoAnnotations() — Method in class AnnotateImageResponse
- If present, logo detection has completed successfully.
- AnnotateImageResponse::setLabelAnnotations() — Method in class AnnotateImageResponse
- If present, label detection has completed successfully.
- AnnotateImageResponse::setTextAnnotations() — Method in class AnnotateImageResponse
- If present, text (OCR) detection has completed successfully.
- AnnotateImageResponse::setFullTextAnnotation() — Method in class AnnotateImageResponse
- If present, text (OCR) detection or document (OCR) text detection has completed successfully.
- AnnotateImageResponse::setSafeSearchAnnotation() — Method in class AnnotateImageResponse
- If present, safe-search annotation has completed successfully.
- AnnotateImageResponse::setImagePropertiesAnnotation() — Method in class AnnotateImageResponse
- If present, image properties were extracted successfully.
- AnnotateImageResponse::setCropHintsAnnotation() — Method in class AnnotateImageResponse
- If present, crop hints have completed successfully.
- AnnotateImageResponse::setWebDetection() — Method in class AnnotateImageResponse
- If present, web detection has completed successfully.
- AnnotateImageResponse::setError() — Method in class AnnotateImageResponse
- If set, represents the error message for the operation.
- AnnotateImageResponse::setContext() — Method in class AnnotateImageResponse
- If present, contextual information is needed to understand where this image comes from.
- AsyncAnnotateFileRequest::setInputConfig() — Method in class AsyncAnnotateFileRequest
- Required. Information about the input file.
- AsyncAnnotateFileRequest::setFeatures() — Method in class AsyncAnnotateFileRequest
- Required. Requested features.
- AsyncAnnotateFileRequest::setImageContext() — Method in class AsyncAnnotateFileRequest
- Additional context that may accompany the image(s) in the file.
- AsyncAnnotateFileRequest::setOutputConfig() — Method in class AsyncAnnotateFileRequest
- Required. The desired output location and metadata (e.g. format).
- AsyncAnnotateFileResponse::setOutputConfig() — Method in class AsyncAnnotateFileResponse
- The output location and metadata from AsyncAnnotateFileRequest.
- AsyncBatchAnnotateFilesRequest::setRequests() — Method in class AsyncBatchAnnotateFilesRequest
- Individual async file annotation requests for this batch.
- AsyncBatchAnnotateFilesResponse::setResponses() — Method in class AsyncBatchAnnotateFilesResponse
- The list of file annotation responses, one for each request in AsyncBatchAnnotateFilesRequest.
- BatchAnnotateImagesRequest::setRequests() — Method in class BatchAnnotateImagesRequest
- Individual image annotation requests for this batch.
- BatchAnnotateImagesResponse::setResponses() — Method in class BatchAnnotateImagesResponse
- Individual responses to image annotation requests within the batch.
- Block::setProperty() — Method in class Block
- Additional information detected for the block.
- Block::setBoundingBox() — Method in class Block
- The bounding box for the block.
- Block::setParagraphs() — Method in class Block
- List of paragraphs in this block (if this blocks is of type text).
- Block::setBlockType() — Method in class Block
- Detected block type (text, image etc) for this block.
- Block::setConfidence() — Method in class Block
- Confidence of the OCR results on the block. Range [0, 1].
- BoundingPoly::setVertices() — Method in class BoundingPoly
- The bounding polygon vertices.
- BoundingPoly::setNormalizedVertices() — Method in class BoundingPoly
- The bounding polygon normalized vertices.
- ColorInfo::setColor() — Method in class ColorInfo
- RGB components of the color.
- ColorInfo::setScore() — Method in class ColorInfo
- Image-specific score for this color. Value in range [0, 1].
- ColorInfo::setPixelFraction() — Method in class ColorInfo
- The fraction of pixels the color occupies in the image.
- CropHint::setBoundingPoly() — Method in class CropHint
- The bounding polygon for the crop region. The coordinates of the bounding
box are in the original image's scale, as returned in
ImageParams. - CropHint::setConfidence() — Method in class CropHint
- Confidence of this being a salient region. Range [0, 1].
- CropHint::setImportanceFraction() — Method in class CropHint
- Fraction of importance of this salient region with respect to the original image.
- CropHintsAnnotation::setCropHints() — Method in class CropHintsAnnotation
- Crop hint results.
- CropHintsParams::setAspectRatios() — Method in class CropHintsParams
- Aspect ratios in floats, representing the ratio of the width to the height of the image. For example, if the desired aspect ratio is 4/3, the corresponding float value should be 1.33333. If not specified, the best possible crop is returned. The number of provided aspect ratios is limited to a maximum of 16; any aspect ratios provided after the 16th are ignored.
- DominantColorsAnnotation::setColors() — Method in class DominantColorsAnnotation
- RGB color values with their score and pixel fraction.
- EntityAnnotation::setMid() — Method in class EntityAnnotation
- Opaque entity ID. Some IDs may be available in Google Knowledge Graph Search API.
- EntityAnnotation::setLocale() — Method in class EntityAnnotation
- The language code for the locale in which the entity textual
descriptionis expressed. - EntityAnnotation::setDescription() — Method in class EntityAnnotation
- Entity textual description, expressed in its
localelanguage. - EntityAnnotation::setScore() — Method in class EntityAnnotation
- Overall score of the result. Range [0, 1].
- EntityAnnotation::setConfidence() — Method in class EntityAnnotation
- Deprecated. Use
scoreinstead. The accuracy of the entity detection in an image. - EntityAnnotation::setTopicality() — Method in class EntityAnnotation
- The relevancy of the ICA (Image Content Annotation) label to the image. For example, the relevancy of "tower" is likely higher to an image containing the detected "Eiffel Tower" than to an image containing a detected distant towering building, even though the confidence that there is a tower in each image may be the same. Range [0, 1].
- EntityAnnotation::setBoundingPoly() — Method in class EntityAnnotation
- Image region to which this entity belongs. Not produced
for
LABEL_DETECTIONfeatures. - EntityAnnotation::setLocations() — Method in class EntityAnnotation
- The location information for the detected entity. Multiple
LocationInfoelements can be present because one location may indicate the location of the scene in the image, and another location may indicate the location of the place where the image was taken. - EntityAnnotation::setProperties() — Method in class EntityAnnotation
- Some entities may have optional user-supplied
Property(name/value) fields, such a score or string that qualifies the entity. - FaceAnnotation::setBoundingPoly() — Method in class FaceAnnotation
- The bounding polygon around the face. The coordinates of the bounding box
are in the original image's scale, as returned in
ImageParams. - FaceAnnotation::setFdBoundingPoly() — Method in class FaceAnnotation
- The
fd_bounding_polybounding polygon is tighter than theboundingPoly, and encloses only the skin part of the face. Typically, it is used to eliminate the face from any image analysis that detects the "amount of skin" visible in an image. It is not based on the landmarker results, only on the initial face detection, hence thefd(face detection) prefix. - FaceAnnotation::setLandmarks() — Method in class FaceAnnotation
- Detected face landmarks.
- FaceAnnotation::setRollAngle() — Method in class FaceAnnotation
- Roll angle, which indicates the amount of clockwise/anti-clockwise rotation of the face relative to the image vertical about the axis perpendicular to the face. Range [-180,180].
- FaceAnnotation::setPanAngle() — Method in class FaceAnnotation
- Yaw angle, which indicates the leftward/rightward angle that the face is pointing relative to the vertical plane perpendicular to the image. Range [-180,180].
- FaceAnnotation::setTiltAngle() — Method in class FaceAnnotation
- Pitch angle, which indicates the upwards/downwards angle that the face is pointing relative to the image's horizontal plane. Range [-180,180].
- FaceAnnotation::setDetectionConfidence() — Method in class FaceAnnotation
- Detection confidence. Range [0, 1].
- FaceAnnotation::setLandmarkingConfidence() — Method in class FaceAnnotation
- Face landmarking confidence. Range [0, 1].
- FaceAnnotation::setJoyLikelihood() — Method in class FaceAnnotation
- Joy likelihood.
- FaceAnnotation::setSorrowLikelihood() — Method in class FaceAnnotation
- Sorrow likelihood.
- FaceAnnotation::setAngerLikelihood() — Method in class FaceAnnotation
- Anger likelihood.
- FaceAnnotation::setSurpriseLikelihood() — Method in class FaceAnnotation
- Surprise likelihood.
- FaceAnnotation::setUnderExposedLikelihood() — Method in class FaceAnnotation
- Under-exposed likelihood.
- FaceAnnotation::setBlurredLikelihood() — Method in class FaceAnnotation
- Blurred likelihood.
- FaceAnnotation::setHeadwearLikelihood() — Method in class FaceAnnotation
- Headwear likelihood.
- FaceAnnotation_Landmark::setType() — Method in class FaceAnnotation_Landmark
- Face landmark type.
- FaceAnnotation_Landmark::setPosition() — Method in class FaceAnnotation_Landmark
- Face landmark position.
- Feature::setType() — Method in class Feature
- The feature type.
- Feature::setMaxResults() — Method in class Feature
- Maximum number of results of this type. Does not apply to
TEXT_DETECTION,DOCUMENT_TEXT_DETECTION, orCROP_HINTS. - Feature::setModel() — Method in class Feature
- Model to use for the feature.
- GcsDestination::setUri() — Method in class GcsDestination
- Google Cloud Storage URI where the results will be stored. Results will be in JSON format and preceded by its corresponding input URI. This field can either represent a single file, or a prefix for multiple outputs.
- GcsSource::setUri() — Method in class GcsSource
- Google Cloud Storage URI for the input file. This must only be a Google Cloud Storage object. Wildcards are not currently supported.
- Image::setContent() — Method in class Image
- Image content, represented as a stream of bytes.
- Image::setSource() — Method in class Image
- Google Cloud Storage image location, or publicly-accessible image
URL. If both
contentandsourceare provided for an image,contenttakes precedence and is used to perform the image annotation request. - ImageAnnotationContext::setUri() — Method in class ImageAnnotationContext
- The URI of the file used to produce the image.
- ImageAnnotationContext::setPageNumber() — Method in class ImageAnnotationContext
- If the file was a PDF or TIFF, this field gives the page number within the file used to produce the image.
- ImageContext::setLatLongRect() — Method in class ImageContext
- Not used.
- ImageContext::setLanguageHints() — Method in class ImageContext
- List of languages to use for TEXT_DETECTION. In most cases, an empty value
yields the best results since it enables automatic language detection. For
languages based on the Latin alphabet, setting
language_hintsis not needed. In rare cases, when the language of the text in the image is known, setting a hint will help get better results (although it will be a significant hindrance if the hint is wrong). Text detection returns an error if one or more of the specified languages is not one of the supported languages. - ImageContext::setCropHintsParams() — Method in class ImageContext
- Parameters for crop hints annotation request.
- ImageContext::setWebDetectionParams() — Method in class ImageContext
- Parameters for web detection.
- ImageProperties::setDominantColors() — Method in class ImageProperties
- If present, dominant colors completed successfully.
- ImageSource::setGcsImageUri() — Method in class ImageSource
- Use
image_uriinstead. The Google Cloud Storage URI of the formgs://bucket_name/object_name. Object versioning is not supported. See Google Cloud Storage Request URIs for more info. - ImageSource::setImageUri() — Method in class ImageSource
- The URI of the source image. Can be either:
1. A Google Cloud Storage URI of the form
gs://bucket_name/object_name. Object versioning is not supported. See Google Cloud Storage Request URIs for more info. - InputConfig::setGcsSource() — Method in class InputConfig
- The Google Cloud Storage location to read the input from.
- InputConfig::setMimeType() — Method in class InputConfig
- The type of the file. Currently only "application/pdf" and "image/tiff" are supported. Wildcards are not supported.
- LatLongRect::setMinLatLng() — Method in class LatLongRect
- Min lat/long pair.
- LatLongRect::setMaxLatLng() — Method in class LatLongRect
- Max lat/long pair.
- LocationInfo::setLatLng() — Method in class LocationInfo
- lat/long location coordinates.
- NormalizedVertex::setX() — Method in class NormalizedVertex
- X coordinate.
- NormalizedVertex::setY() — Method in class NormalizedVertex
- Y coordinate.
- OperationMetadata::setState() — Method in class OperationMetadata
- Current state of the batch operation.
- OperationMetadata::setCreateTime() — Method in class OperationMetadata
- The time when the batch request was received.
- OperationMetadata::setUpdateTime() — Method in class OperationMetadata
- The time when the operation result was last updated.
- OutputConfig::setGcsDestination() — Method in class OutputConfig
- The Google Cloud Storage location to write the output(s) to.
- OutputConfig::setBatchSize() — Method in class OutputConfig
- The max number of response protos to put into each output JSON file on Google Cloud Storage.
- Page::setProperty() — Method in class Page
- Additional information detected on the page.
- Page::setWidth() — Method in class Page
- Page width. For PDFs the unit is points. For images (including TIFFs) the unit is pixels.
- Page::setHeight() — Method in class Page
- Page height. For PDFs the unit is points. For images (including TIFFs) the unit is pixels.
- Page::setBlocks() — Method in class Page
- List of blocks of text, images etc on this page.
- Page::setConfidence() — Method in class Page
- Confidence of the OCR results on the page. Range [0, 1].
- Paragraph::setProperty() — Method in class Paragraph
- Additional information detected for the paragraph.
- Paragraph::setBoundingBox() — Method in class Paragraph
- The bounding box for the paragraph.
- Paragraph::setWords() — Method in class Paragraph
- List of words in this paragraph.
- Paragraph::setConfidence() — Method in class Paragraph
- Confidence of the OCR results for the paragraph. Range [0, 1].
- Position::setX() — Method in class Position
- X coordinate.
- Position::setY() — Method in class Position
- Y coordinate.
- Position::setZ() — Method in class Position
- Z coordinate (or depth).
- Property::setName() — Method in class Property
- Name of the property.
- Property::setValue() — Method in class Property
- Value of the property.
- Property::setUint64Value() — Method in class Property
- Value of numeric properties.
- SafeSearchAnnotation — Class in namespace Google\Cloud\Vision\V1
- Set of features pertaining to the image, computed by computer vision methods over safe-search verticals (for example, adult, spoof, medical, violence).
- SafeSearchAnnotation::setAdult() — Method in class SafeSearchAnnotation
- Represents the adult content likelihood for the image. Adult content may contain elements such as nudity, pornographic images or cartoons, or sexual activities.
- SafeSearchAnnotation::setSpoof() — Method in class SafeSearchAnnotation
- Spoof likelihood. The likelihood that an modification was made to the image's canonical version to make it appear funny or offensive.
- SafeSearchAnnotation::setMedical() — Method in class SafeSearchAnnotation
- Likelihood that this is a medical image.
- SafeSearchAnnotation::setViolence() — Method in class SafeSearchAnnotation
- Likelihood that this image contains violent content.
- SafeSearchAnnotation::setRacy() — Method in class SafeSearchAnnotation
- Likelihood that the request image contains racy content. Racy content may include (but is not limited to) skimpy or sheer clothing, strategically covered nudity, lewd or provocative poses, or close-ups of sensitive body areas.
- Symbol — Class in namespace Google\Cloud\Vision\V1
- A single symbol representation.
- Symbol::setProperty() — Method in class Symbol
- Additional information detected for the symbol.
- Symbol::setBoundingBox() — Method in class Symbol
- The bounding box for the symbol.
- Symbol::setText() — Method in class Symbol
- The actual UTF-8 representation of the symbol.
- Symbol::setConfidence() — Method in class Symbol
- Confidence of the OCR results for the symbol. Range [0, 1].
- TextAnnotation::setPages() — Method in class TextAnnotation
- List of pages detected by OCR.
- TextAnnotation::setText() — Method in class TextAnnotation
- UTF-8 text detected on the pages.
- TextAnnotation_DetectedBreak::setType() — Method in class TextAnnotation_DetectedBreak
- Detected break type.
- TextAnnotation_DetectedBreak::setIsPrefix() — Method in class TextAnnotation_DetectedBreak
- True if break prepends the element.
- TextAnnotation_DetectedLanguage::setLanguageCode() — Method in class TextAnnotation_DetectedLanguage
- The BCP-47 language code, such as "en-US" or "sr-Latn". For more information, see http://www.unicode.org/reports/tr35/#Unicode_locale_identifier.
- TextAnnotation_DetectedLanguage::setConfidence() — Method in class TextAnnotation_DetectedLanguage
- Confidence of detected language. Range [0, 1].
- TextAnnotation_TextProperty::setDetectedLanguages() — Method in class TextAnnotation_TextProperty
- A list of detected languages together with confidence.
- TextAnnotation_TextProperty::setDetectedBreak() — Method in class TextAnnotation_TextProperty
- Detected start or end of a text segment.
- Vertex::setX() — Method in class Vertex
- X coordinate.
- Vertex::setY() — Method in class Vertex
- Y coordinate.
- WebDetection::setWebEntities() — Method in class WebDetection
- Deduced entities from similar images on the Internet.
- WebDetection::setFullMatchingImages() — Method in class WebDetection
- Fully matching images from the Internet.
- WebDetection::setPartialMatchingImages() — Method in class WebDetection
- Partial matching images from the Internet.
- WebDetection::setPagesWithMatchingImages() — Method in class WebDetection
- Web pages containing the matching images from the Internet.
- WebDetection::setVisuallySimilarImages() — Method in class WebDetection
- The visually similar image results.
- WebDetection::setBestGuessLabels() — Method in class WebDetection
- Best guess text labels for the request image.
- WebDetectionParams::setIncludeGeoResults() — Method in class WebDetectionParams
- Whether to include results derived from the geo information in the image.
- WebDetection_WebEntity::setEntityId() — Method in class WebDetection_WebEntity
- Opaque entity ID.
- WebDetection_WebEntity::setScore() — Method in class WebDetection_WebEntity
- Overall relevancy score for the entity.
- WebDetection_WebEntity::setDescription() — Method in class WebDetection_WebEntity
- Canonical description of the entity, in English.
- WebDetection_WebImage::setUrl() — Method in class WebDetection_WebImage
- The result image URL.
- WebDetection_WebImage::setScore() — Method in class WebDetection_WebImage
- (Deprecated) Overall relevancy score for the image.
- WebDetection_WebLabel::setLabel() — Method in class WebDetection_WebLabel
- Label for extra metadata.
- WebDetection_WebLabel::setLanguageCode() — Method in class WebDetection_WebLabel
- The BCP-47 language code for
label, such as "en-US" or "sr-Latn". - WebDetection_WebPage::setUrl() — Method in class WebDetection_WebPage
- The result web page URL.
- WebDetection_WebPage::setScore() — Method in class WebDetection_WebPage
- (Deprecated) Overall relevancy score for the web page.
- WebDetection_WebPage::setPageTitle() — Method in class WebDetection_WebPage
- Title for the web page, may contain HTML markups.
- WebDetection_WebPage::setFullMatchingImages() — Method in class WebDetection_WebPage
- Fully matching images on the page.
- WebDetection_WebPage::setPartialMatchingImages() — Method in class WebDetection_WebPage
- Partial matching images on the page.
- Word::setProperty() — Method in class Word
- Additional information detected for the word.
- Word::setBoundingBox() — Method in class Word
- The bounding box for the word.
- Word::setSymbols() — Method in class Word
- List of symbols in the word.
- Word::setConfidence() — Method in class Word
- Confidence of the OCR results for the word. Range [0, 1].
- AuditData::setPolicyDelta() — Method in class AuditData
- Policy delta between the original policy and the newly set policy.
- CancelOperationRequest::setName() — Method in class CancelOperationRequest
- The name of the operation resource to be cancelled.
- DeleteOperationRequest::setName() — Method in class DeleteOperationRequest
- The name of the operation resource to be deleted.
- GetOperationRequest::setName() — Method in class GetOperationRequest
- The name of the operation resource.
- ListOperationsRequest::setName() — Method in class ListOperationsRequest
- The name of the operation collection.
- ListOperationsRequest::setFilter() — Method in class ListOperationsRequest
- The standard list filter.
- ListOperationsRequest::setPageSize() — Method in class ListOperationsRequest
- The standard list page size.
- ListOperationsRequest::setPageToken() — Method in class ListOperationsRequest
- The standard list page token.
- ListOperationsResponse::setOperations() — Method in class ListOperationsResponse
- A list of operations that matches the specified filter in the request.
- ListOperationsResponse::setNextPageToken() — Method in class ListOperationsResponse
- The standard List next-page token.
- Operation::setName() — Method in class Operation
- The server-assigned name, which is only unique within the same service that
originally returns it. If you use the default HTTP mapping, the
nameshould have the format ofoperations/some/unique/name. - Operation::setMetadata() — Method in class Operation
- Service-specific metadata associated with the operation. It typically contains progress information and common metadata such as create time.
- Operation::setDone() — Method in class Operation
- If the value is
false, it means the operation is still in progress. - Operation::setError() — Method in class Operation
- The error result of the operation in case of failure or cancellation.
- Operation::setResponse() — Method in class Operation
- The normal response of the operation in case of success. If the original
method returns no data on success, such as
Delete, the response isgoogle.protobuf.Empty. If the original method is standardGet/Create/Update, the response should be the resource. For other methods, the response should have the typeXxxResponse, whereXxxis the original method name. For example, if the original method name isTakeSnapshot(), the inferred response type isTakeSnapshotResponse. - BadRequest::setFieldViolations() — Method in class BadRequest
- Describes all violations in a client request.
- BadRequest_FieldViolation::setField() — Method in class BadRequest_FieldViolation
- A path leading to a field in the request body. The value will be a sequence of dot-separated identifiers that identify a protocol buffer field. E.g., "field_violations.field" would identify this field.
- BadRequest_FieldViolation::setDescription() — Method in class BadRequest_FieldViolation
- A description of why the request element is bad.
- DebugInfo::setStackEntries() — Method in class DebugInfo
- The stack trace entries indicating where the error occurred.
- DebugInfo::setDetail() — Method in class DebugInfo
- Additional debugging information provided by the server.
- Help::setLinks() — Method in class Help
- URL(s) pointing to additional information on handling the current error.
- Help_Link::setDescription() — Method in class Help_Link
- Describes what the link offers.
- Help_Link::setUrl() — Method in class Help_Link
- The URL of the link.
- LocalizedMessage::setLocale() — Method in class LocalizedMessage
- The locale used following the specification defined at http://www.rfc-editor.org/rfc/bcp/bcp47.txt.
- LocalizedMessage::setMessage() — Method in class LocalizedMessage
- The localized error message in the above locale.
- PreconditionFailure::setViolations() — Method in class PreconditionFailure
- Describes all precondition violations.
- PreconditionFailure_Violation::setType() — Method in class PreconditionFailure_Violation
- The type of PreconditionFailure. We recommend using a service-specific enum type to define the supported precondition violation types. For example, "TOS" for "Terms of Service violation".
- PreconditionFailure_Violation::setSubject() — Method in class PreconditionFailure_Violation
- The subject, relative to the type, that failed.
- PreconditionFailure_Violation::setDescription() — Method in class PreconditionFailure_Violation
- A description of how the precondition failed. Developers can use this description to understand how to fix the failure.
- QuotaFailure::setViolations() — Method in class QuotaFailure
- Describes all quota violations.
- QuotaFailure_Violation::setSubject() — Method in class QuotaFailure_Violation
- The subject on which the quota check failed.
- QuotaFailure_Violation::setDescription() — Method in class QuotaFailure_Violation
- A description of how the quota check failed. Clients can use this description to find more about the quota configuration in the service's public documentation, or find the relevant quota limit to adjust through developer console.
- RequestInfo::setRequestId() — Method in class RequestInfo
- An opaque string that should only be interpreted by the service generating it. For example, it can be used to identify requests in the service's logs.
- RequestInfo::setServingData() — Method in class RequestInfo
- Any data that was used to serve this request. For example, an encrypted stack trace that can be sent back to the service provider for debugging.
- ResourceInfo::setResourceType() — Method in class ResourceInfo
- A name for the type of resource being accessed, e.g. "sql table", "cloud storage bucket", "file", "Google calendar"; or the type URL of the resource: e.g. "type.googleapis.com/google.pubsub.v1.Topic".
- ResourceInfo::setResourceName() — Method in class ResourceInfo
- The name of the resource being accessed. For example, a shared calendar name: "example.com_4fghdhgsrgh@group.calendar.google.com", if the current error is [google.rpc.Code.PERMISSION_DENIED][google.rpc.Code.PERMISSION_DENIED].
- ResourceInfo::setOwner() — Method in class ResourceInfo
- The owner of the resource (optional).
- ResourceInfo::setDescription() — Method in class ResourceInfo
- Describes what error is encountered when accessing this resource.
- RetryInfo::setRetryDelay() — Method in class RetryInfo
- Clients should wait at least this long between retrying the same request.
- Status — Class in namespace Google\Rpc
- The
Statustype defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by gRPC. The error model is designed to be: - Simple to use and understand for most users - Flexible enough to meet unexpected needsOverview
The
Statusmessage contains three pieces of data: error code, error message, and error details. The error code should be an enum value of [google.rpc.Code][google.rpc.Code], but it may accept additional error codes if needed. The error message should be a developer-facing English message that helps developers understand and resolve the error. If a localized user-facing error message is needed, put the localized message in the error details or localize it in the client. The optional error details may contain arbitrary information about the error. There is a predefined set of error detail types in the packagegoogle.rpcthat can be used for common error conditions. - Status::setCode() — Method in class Status
- The status code, which should be an enum value of [google.rpc.Code][google.rpc.Code].
- Status::setMessage() — Method in class Status
- A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the [google.rpc.Status.details][google.rpc.Status.details] field, or localized by the client.
- Status::setDetails() — Method in class Status
- A list of messages that carry the error details. There is a common set of message types for APIs to use.
- Color::setRed() — Method in class Color
- The amount of red in the color as a value in the interval [0, 1].
- Color::setGreen() — Method in class Color
- The amount of green in the color as a value in the interval [0, 1].
- Color::setBlue() — Method in class Color
- The amount of blue in the color as a value in the interval [0, 1].
- Color::setAlpha() — Method in class Color
- The fraction of this color that should be applied to the pixel. That is, the final pixel color is defined by the equation: pixel color = alpha * (this color) + (1.0 - alpha) * (background color) This means that a value of 1.0 corresponds to a solid color, whereas a value of 0.0 corresponds to a completely transparent color. This uses a wrapper message rather than a simple float scalar so that it is possible to distinguish between a default value and the value being unset.
- Date::setYear() — Method in class Date
- Year of date. Must be from 1 to 9999, or 0 if specifying a date without a year.
- Date::setMonth() — Method in class Date
- Month of year. Must be from 1 to 12.
- Date::setDay() — Method in class Date
- Day of month. Must be from 1 to 31 and valid for the year and month, or 0 if specifying a year/month where the day is not significant.
- LatLng::setLatitude() — Method in class LatLng
- The latitude in degrees. It must be in the range [-90.0, +90.0].
- LatLng::setLongitude() — Method in class LatLng
- The longitude in degrees. It must be in the range [-180.0, +180.0].
- Money::setCurrencyCode() — Method in class Money
- The 3-letter currency code defined in ISO 4217.
- Money::setUnits() — Method in class Money
- The whole units of the amount.
- Money::setNanos() — Method in class Money
- Number of nano (10^-9) units of the amount.
- PostalAddress::setRevision() — Method in class PostalAddress
- The schema revision of the
PostalAddress. - PostalAddress::setRegionCode() — Method in class PostalAddress
- Required. CLDR region code of the country/region of the address. This is never inferred and it is up to the user to ensure the value is correct. See http://cldr.unicode.org/ and http://www.unicode.org/cldr/charts/30/supplemental/territory_information.html for details. Example: "CH" for Switzerland.
- PostalAddress::setLanguageCode() — Method in class PostalAddress
- Optional. BCP-47 language code of the contents of this address (if known). This is often the UI language of the input form or is expected to match one of the languages used in the address' country/region, or their transliterated equivalents.
- PostalAddress::setPostalCode() — Method in class PostalAddress
- Optional. Postal code of the address. Not all countries use or require postal codes to be present, but where they are used, they may trigger additional validation with other parts of the address (e.g. state/zip validation in the U.S.A.).
- PostalAddress::setSortingCode() — Method in class PostalAddress
- Optional. Additional, country-specific, sorting code. This is not used in most regions. Where it is used, the value is either a string like "CEDEX", optionally followed by a number (e.g. "CEDEX 7"), or just a number alone, representing the "sector code" (Jamaica), "delivery area indicator" (Malawi) or "post office indicator" (e.g. Côte d'Ivoire).
- PostalAddress::setAdministrativeArea() — Method in class PostalAddress
- Optional. Highest administrative subdivision which is used for postal addresses of a country or region.
- PostalAddress::setLocality() — Method in class PostalAddress
- Optional. Generally refers to the city/town portion of the address.
- PostalAddress::setSublocality() — Method in class PostalAddress
- Optional. Sublocality of the address.
- PostalAddress::setAddressLines() — Method in class PostalAddress
- Unstructured address lines describing the lower levels of an address.
- PostalAddress::setRecipients() — Method in class PostalAddress
- Optional. The recipient at the address.
- PostalAddress::setOrganization() — Method in class PostalAddress
- Optional. The name of the organization at the address.
- TimeOfDay::setHours() — Method in class TimeOfDay
- Hours of day in 24 hour format. Should be from 0 to 23. An API may choose to allow the value "24:00:00" for scenarios like business closing time.
- TimeOfDay::setMinutes() — Method in class TimeOfDay
- Minutes of hour of day. Must be from 0 to 59.
- TimeOfDay::setSeconds() — Method in class TimeOfDay
- Seconds of minutes of the time. Must normally be from 0 to 59. An API may allow the value 60 if it allows leap-seconds.
- TimeOfDay::setNanos() — Method in class TimeOfDay
- Fractions of seconds in nanoseconds. Must be from 0 to 999,999,999.
T
- $GapicClientTrait#transport — Property in class GapicClientTrait
- $LexerError#text — Property in class LexerError
- $LexerError#token — Property in class LexerError
- $Parser#terminals — Property in class Parser
- $Parser#table — Property in class Parser
- Parser::trace() — Method in class Parser
- $ParserError#text — Property in class ParserError
- $ParserValue#text — Property in class ParserValue
- Serializer::toSnakeCase() — Method in class Serializer
- Convert string from camelCase to snake_case
- Serializer::toCamelCase() — Method in class Serializer
- Convert string from snake_case to camelCase
- TransportInterface — Class in namespace Google\ApiCore\Transport
- TransferConfig — Class in namespace Google\Cloud\BigQuery\DataTransfer\V1
- Represents a data transfer configuration. A transfer configuration
contains all metadata needed to perform a data transfer. For example,
destination_dataset_idspecifies where data should be stored. - TransferMessage — Class in namespace Google\Cloud\BigQuery\DataTransfer\V1
- Represents a user facing message for a particular data transfer run.
- TransferMessage_MessageSeverity — Class in namespace Google\Cloud\BigQuery\DataTransfer\V1
- Represents data transfer user facing message severity.
- TransferRun — Class in namespace Google\Cloud\BigQuery\DataTransfer\V1
- Represents a data transfer run.
- TransferState — Class in namespace Google\Cloud\BigQuery\DataTransfer\V1
- Represents data transfer run state.
- TransferType — Class in namespace Google\Cloud\BigQuery\DataTransfer\V1
- DEPRECATED. Represents data transfer type.
- BigtableInstanceAdminGrpcClient::TestIamPermissions() — Method in class BigtableInstanceAdminGrpcClient
- Returns permissions that the caller has on the specified instance resource.
- $DropRowRangeRequest#target — Property in class DropRowRangeRequest
- Table — Class in namespace Google\Cloud\Bigtable\Admin\V2
- A collection of user data indexed by row, column, and timestamp.
- Table_ClusterState — Class in namespace Google\Cloud\Bigtable\Admin\V2
- The state of a table's data in a particular cluster.
- Table_ClusterState_ReplicationState — Class in namespace Google\Cloud\Bigtable\Admin\V2
- Table replication states.
- Table_TimestampGranularity — Class in namespace Google\Cloud\Bigtable\Admin\V2
- Possible timestamp granularities to use when keeping multiple versions of data in a table.
- Table_View — Class in namespace Google\Cloud\Bigtable\Admin\V2
- Defines a view over a table's fields.
- TimestampRange — Class in namespace Google\Cloud\Bigtable\V2
- Specified a contiguous range of microsecond timestamps.
- $Job#type_job — Property in class Job
- AgentsGrpcClient::TrainAgent() — Method in class AgentsGrpcClient
- Trains the specified agent.
- TextInput — Class in namespace Google\Cloud\Dialogflow\V2
- Represents the natural language text to be processed.
- TrainAgentRequest — Class in namespace Google\Cloud\Dialogflow\V2
- The request message for [Agents.TrainAgent][google.cloud.dialogflow.v2.Agents.TrainAgent].
- $CustomInfoType#type — Property in class CustomInfoType
- $CustomInfoType_DetectionRule#type — Property in class CustomInfoType_DetectionRule
- $DeidentifyConfig#transformation — Property in class DeidentifyConfig
- $FieldTransformation#transformation — Property in class FieldTransformation
- $JobTrigger_Trigger#trigger — Property in class JobTrigger_Trigger
- $OutputStorageConfig#type — Property in class OutputStorageConfig
- $PrimitiveTransformation#transformation — Property in class PrimitiveTransformation
- $PrivacyMetric#type — Property in class PrivacyMetric
- $PrivacyMetric_KMapEstimationConfig_TaggedField#tag — Property in class PrivacyMetric_KMapEstimationConfig_TaggedField
- $RecordCondition_Expressions#type — Property in class RecordCondition_Expressions
- $RecordKey#type — Property in class RecordKey
- $RedactImageRequest_ImageRedactionConfig#target — Property in class RedactImageRequest_ImageRedactionConfig
- $StorageConfig#type — Property in class StorageConfig
- Table — Class in namespace Google\Cloud\Dlp\V2
- Structured content to inspect. Up to 50,000
Values per request allowed. - TableLocation — Class in namespace Google\Cloud\Dlp\V2
- Location of a finding within a table.
- Table_Row — Class in namespace Google\Cloud\Dlp\V2
- Generated from protobuf message
google.privacy.dlp.v2.Table.Row - TimePartConfig — Class in namespace Google\Cloud\Dlp\V2
- For use with
Date,Timestamp, andTimeOfDay, extract or preserve a portion of the value. - TimePartConfig_TimePart — Class in namespace Google\Cloud\Dlp\V2
- Protobuf enum
Google\Privacy\Dlp\V2\TimePartConfig\TimePart - TransformationOverview — Class in namespace Google\Cloud\Dlp\V2
- Overview of the modifications that occurred.
- TransformationSummary — Class in namespace Google\Cloud\Dlp\V2
- Summary of a single tranformation.
- TransformationSummary_SummaryResult — Class in namespace Google\Cloud\Dlp\V2
- A collection that informs the user the number of times a particular
TransformationResultCodeand error details occurred. - TransformationSummary_TransformationResultCode — Class in namespace Google\Cloud\Dlp\V2
- Possible outcomes of transformations.
- TransientCryptoKey — Class in namespace Google\Cloud\Dlp\V2
- Use this to have a random data crypto key generated.
- $Value#type — Property in class Value
- TimedCount — Class in namespace Google\Cloud\ErrorReporting\V1beta1
- The number of errors in a given time period.
- TimedCountAlignment — Class in namespace Google\Cloud\ErrorReporting\V1beta1
- Specifies how the time periods of error group counts are aligned.
- TrackingIssue — Class in namespace Google\Cloud\ErrorReporting\V1beta1
- Information related to tracking the progress on resolving the error.
- $DocumentTransform_FieldTransform#transform_type — Property in class DocumentTransform_FieldTransform
- $ListenRequest#target_change — Property in class ListenRequest
- Target — Class in namespace Google\Cloud\Firestore\V1beta1
- A specification of a set of documents to listen to.
- $Target#target_type — Property in class Target
- TargetChange — Class in namespace Google\Cloud\Firestore\V1beta1
- Targets being watched have changed.
- TargetChange_TargetChangeType — Class in namespace Google\Cloud\Firestore\V1beta1
- The type of change.
- Target_DocumentsTarget — Class in namespace Google\Cloud\Firestore\V1beta1
- A target specified by a set of documents names.
- Target_QueryTarget — Class in namespace Google\Cloud\Firestore\V1beta1
- A target specified by a query.
- TransactionOptions — Class in namespace Google\Cloud\Firestore\V1beta1
- Options for creating a new transaction.
- TransactionOptions_ReadOnly — Class in namespace Google\Cloud\Firestore\V1beta1
- Options for a transaction that can only be used to read documents.
- TransactionOptions_ReadWrite — Class in namespace Google\Cloud\Firestore\V1beta1
- Options for a transaction that can be used to read and write documents.
- IAMPolicyGrpcClient::TestIamPermissions() — Method in class IAMPolicyGrpcClient
- Returns permissions that a caller has on the specified resource.
- TestIamPermissionsRequest — Class in namespace Google\Cloud\Iam\V1
- Request message for
TestIamPermissionsmethod. - TestIamPermissionsResponse — Class in namespace Google\Cloud\Iam\V1
- Response message for
TestIamPermissionsmethod. - DeviceManagerGrpcClient::TestIamPermissions() — Method in class DeviceManagerGrpcClient
- Returns permissions that a caller has on the specified resource.
- TextSpan — Class in namespace Google\Cloud\Language\V1beta2
- Represents an output piece of text.
- Token — Class in namespace Google\Cloud\Language\V1beta2
- Represents the smallest syntactic building block of the text.
- $AlertPolicy_Condition_Trigger#type — Property in class AlertPolicy_Condition_Trigger
- TimeInterval — Class in namespace Google\Cloud\Monitoring\V3
- A time interval extending just after a start time through an end time.
- TimeSeries — Class in namespace Google\Cloud\Monitoring\V3
- A collection of data points that describes the time-varying values of a metric. A time series is identified by a combination of a fully-specified monitored resource and a fully-specified metric.
- TypedValue — Class in namespace Google\Cloud\Monitoring\V3
- A single strongly-typed value.
- $SeekRequest#target — Property in class SeekRequest
- Topic — Class in namespace Google\Cloud\PubSub\V1
- A topic resource.
- DatabaseAdminGrpcClient::TestIamPermissions() — Method in class DatabaseAdminGrpcClient
- Returns permissions that the caller has on the specified database resource.
- InstanceAdminGrpcClient::TestIamPermissions() — Method in class InstanceAdminGrpcClient
- Returns permissions that the caller has on the specified instance resource.
- $CommitRequest#transaction — Property in class CommitRequest
- Transaction — Class in namespace Google\Cloud\Spanner\V1
- A transaction.
- TransactionOptions — Class in namespace Google\Cloud\Spanner\V1
Transactions
Each session can have at most one active transaction at a time. After the active transaction is completed, the session can immediately be re-used for the next transaction. It is not necessary to create a new session for each transaction.
- TransactionOptions_ReadOnly — Class in namespace Google\Cloud\Spanner\V1
- Message type to initiate a read-only transaction.
- $TransactionOptions_ReadOnly#timestamp_bound — Property in class TransactionOptions_ReadOnly
- TransactionOptions_ReadWrite — Class in namespace Google\Cloud\Spanner\V1
- Message type to initiate a read-write transaction. Currently this transaction type has no options.
- TransactionSelector — Class in namespace Google\Cloud\Spanner\V1
- This message is used to select the transaction in which a [Read][google.spanner.v1.Spanner.Read] or [ExecuteSql][google.spanner.v1.Spanner.ExecuteSql] call runs.
- Type — Class in namespace Google\Cloud\Spanner\V1
Typeindicates the type of a Cloud Spanner value, as might be stored in a table cell or returned from an SQL query.- TypeCode — Class in namespace Google\Cloud\Spanner\V1
TypeCodeis used as part of [Type][google.spanner.v1.Type] to indicate the type of a Cloud Spanner value.- CloudTasksGrpcClient::TestIamPermissions() — Method in class CloudTasksGrpcClient
- Returns permissions that a caller has on a [Queue][google.cloud.tasks.v2beta2.Queue].
- $Queue#target_type — Property in class Queue
- Task — Class in namespace Google\Cloud\Tasks\V2beta2
- A unit of scheduled work.
- TaskStatus — Class in namespace Google\Cloud\Tasks\V2beta2
- Status of the task.
- Task_View — Class in namespace Google\Cloud\Tasks\V2beta2
- The view specifies a subset of [Task][google.cloud.tasks.v2beta2.Task] data.
- TraceServiceGrpcClient — Class in namespace Google\Cloud\Trace\V2
- This file describes an API for collecting and viewing traces and spans within a trace. A Trace is a collection of spans corresponding to a single operation or set of operations for an application. A span is an individual timed event which forms a node of the trace tree. A single trace may contain span(s) from multiple services.
- TruncatableString — Class in namespace Google\Cloud\Trace\V2
- Represents a string that might be shortened to a specified length.
- TextAnnotation — Class in namespace Google\Cloud\Vision\V1
- TextAnnotation contains a structured representation of OCR extracted text.
- TextAnnotation_DetectedBreak — Class in namespace Google\Cloud\Vision\V1
- Detected start or end of a structural component.
- TextAnnotation_DetectedBreak_BreakType — Class in namespace Google\Cloud\Vision\V1
- Enum to denote the type of break found. New line, space etc.
- TextAnnotation_DetectedLanguage — Class in namespace Google\Cloud\Vision\V1
- Detected language for a structural component.
- TextAnnotation_TextProperty — Class in namespace Google\Cloud\Vision\V1
- Additional information detected on the structural component.
- TimeOfDay — Class in namespace Google\Type
- Represents a time of day. The date and time zone are either not significant
or are specified elsewhere. An API may chose to allow leap seconds. Related
types are [google.type.Date][google.type.Date] and
google.protobuf.Timestamp.
U
- Parser::unput() — Method in class Parser
- Parser::upcomingInput() — Method in class Parser
- UriTrait — Class in namespace Google\ApiCore
- Provides a light wrapper around often used URI related functions.
- Usage — Class in namespace Google\Api
- Configuration controlling usage of a service.
- UsageRule — Class in namespace Google\Api
- Usage configuration rules for the service.
- DataTransferServiceGrpcClient::UpdateTransferConfig() — Method in class DataTransferServiceGrpcClient
- Updates a data transfer configuration.
- UpdateTransferConfigRequest — Class in namespace Google\Cloud\BigQuery\DataTransfer\V1
- A request to update a transfer configuration. To update the user id of the transfer configuration, an authorization code needs to be provided.
- BigtableInstanceAdminGrpcClient::UpdateInstance() — Method in class BigtableInstanceAdminGrpcClient
- Updates an instance within a project.
- BigtableInstanceAdminGrpcClient::UpdateCluster() — Method in class BigtableInstanceAdminGrpcClient
- Updates a cluster within an instance.
- BigtableInstanceAdminGrpcClient::UpdateAppProfile() — Method in class BigtableInstanceAdminGrpcClient
- Updates an app profile within an instance.
- UpdateAppProfileMetadata — Class in namespace Google\Cloud\Bigtable\Admin\V2
- The metadata for the Operation returned by UpdateAppProfile.
- UpdateAppProfileRequest — Class in namespace Google\Cloud\Bigtable\Admin\V2
- Request message for BigtableInstanceAdmin.UpdateAppProfile.
- UpdateClusterMetadata — Class in namespace Google\Cloud\Bigtable\Admin\V2
- The metadata for the Operation returned by UpdateCluster.
- UpdateInstanceMetadata — Class in namespace Google\Cloud\Bigtable\Admin\V2
- The metadata for the Operation returned by UpdateInstance.
- ClusterManagerGrpcClient::UpdateCluster() — Method in class ClusterManagerGrpcClient
- Updates the settings of a specific cluster.
- ClusterManagerGrpcClient::UpdateNodePool() — Method in class ClusterManagerGrpcClient
- Updates the version and/or image type of a specific node pool.
- ClusterManagerGrpcClient::UpdateMaster() — Method in class ClusterManagerGrpcClient
- Updates the master of a specific cluster.
- UpdateClusterRequest — Class in namespace Google\Cloud\Container\V1
- UpdateClusterRequest updates the settings of a cluster.
- UpdateMasterRequest — Class in namespace Google\Cloud\Container\V1
- UpdateMasterRequest updates the master of the cluster.
- UpdateNodePoolRequest — Class in namespace Google\Cloud\Container\V1
- UpdateNodePoolRequests update a node pool's image and/or version.
- ClusterControllerGrpcClient::UpdateCluster() — Method in class ClusterControllerGrpcClient
- Updates a cluster in a project.
- JobControllerGrpcClient::UpdateJob() — Method in class JobControllerGrpcClient
- Updates a job in a project.
- UpdateClusterRequest — Class in namespace Google\Cloud\Dataproc\V1
- A request to update a cluster.
- UpdateJobRequest — Class in namespace Google\Cloud\Dataproc\V1
- A request to update a job.
- Controller2GrpcClient::UpdateActiveBreakpoint() — Method in class Controller2GrpcClient
- Updates the breakpoint state or mutable fields.
- UpdateActiveBreakpointRequest — Class in namespace Google\Cloud\Debugger\V2
- Request to update an active breakpoint.
- UpdateActiveBreakpointResponse — Class in namespace Google\Cloud\Debugger\V2
- Response for updating an active breakpoint.
- ContextsGrpcClient::UpdateContext() — Method in class ContextsGrpcClient
- Updates the specified context.
- EntityTypesGrpcClient::UpdateEntityType() — Method in class EntityTypesGrpcClient
- Updates the specified entity type.
- IntentsGrpcClient::UpdateIntent() — Method in class IntentsGrpcClient
- Updates the specified intent.
- SessionEntityTypesGrpcClient::UpdateSessionEntityType() — Method in class SessionEntityTypesGrpcClient
- Updates the specified session entity type.
- UpdateContextRequest — Class in namespace Google\Cloud\Dialogflow\V2
- The request message for [Contexts.UpdateContext][google.cloud.dialogflow.v2.Contexts.UpdateContext].
- UpdateEntityTypeRequest — Class in namespace Google\Cloud\Dialogflow\V2
- The request message for [EntityTypes.UpdateEntityType][google.cloud.dialogflow.v2.EntityTypes.UpdateEntityType].
- UpdateIntentRequest — Class in namespace Google\Cloud\Dialogflow\V2
- The request message for [Intents.UpdateIntent][google.cloud.dialogflow.v2.Intents.UpdateIntent].
- UpdateSessionEntityTypeRequest — Class in namespace Google\Cloud\Dialogflow\V2
- The request message for [SessionEntityTypes.UpdateSessionEntityType][google.cloud.dialogflow.v2.SessionEntityTypes.UpdateSessionEntityType].
- DlpServiceGrpcClient::UpdateInspectTemplate() — Method in class DlpServiceGrpcClient
- Updates the InspectTemplate.
- DlpServiceGrpcClient::UpdateDeidentifyTemplate() — Method in class DlpServiceGrpcClient
- Updates the DeidentifyTemplate.
- DlpServiceGrpcClient::UpdateJobTrigger() — Method in class DlpServiceGrpcClient
- Updates a job trigger.
- UnwrappedCryptoKey — Class in namespace Google\Cloud\Dlp\V2
- Using raw keys is prone to security risks due to accidentally leaking the key. Choose another type of key if possible.
- UpdateDeidentifyTemplateRequest — Class in namespace Google\Cloud\Dlp\V2
- Request message for UpdateDeidentifyTemplate.
- UpdateInspectTemplateRequest — Class in namespace Google\Cloud\Dlp\V2
- Request message for UpdateInspectTemplate.
- UpdateJobTriggerRequest — Class in namespace Google\Cloud\Dlp\V2
- Request message for UpdateJobTrigger.
- ErrorGroupServiceGrpcClient::UpdateGroup() — Method in class ErrorGroupServiceGrpcClient
- Replace the data for the specified group.
- UpdateGroupRequest — Class in namespace Google\Cloud\ErrorReporting\V1beta1
- A request to replace the existing data for the given group.
- FirestoreGrpcClient::UpdateDocument() — Method in class FirestoreGrpcClient
- Updates or inserts a document.
- UpdateDocumentRequest — Class in namespace Google\Cloud\Firestore\V1beta1
- The request for [Firestore.UpdateDocument][google.firestore.v1beta1.Firestore.UpdateDocument].
- DeviceManagerGrpcClient::UpdateDeviceRegistry() — Method in class DeviceManagerGrpcClient
- Updates a device registry configuration.
- DeviceManagerGrpcClient::UpdateDevice() — Method in class DeviceManagerGrpcClient
- Updates a device.
- UpdateDeviceRegistryRequest — Class in namespace Google\Cloud\Iot\V1
- Request for
UpdateDeviceRegistry. - UpdateDeviceRequest — Class in namespace Google\Cloud\Iot\V1
- Request for
UpdateDevice. - ConfigServiceV2GrpcClient::UpdateSink() — Method in class ConfigServiceV2GrpcClient
- Updates a sink. This method replaces the following fields in the existing
sink with values from the new sink:
destination, andfilter. - ConfigServiceV2GrpcClient::UpdateExclusion() — Method in class ConfigServiceV2GrpcClient
- Changes one or more properties of an existing exclusion.
- MetricsServiceV2GrpcClient::UpdateLogMetric() — Method in class MetricsServiceV2GrpcClient
- Creates or updates a logs-based metric.
- UpdateExclusionRequest — Class in namespace Google\Cloud\Logging\V2
- The parameters to
UpdateExclusion. - UpdateLogMetricRequest — Class in namespace Google\Cloud\Logging\V2
- The parameters to UpdateLogMetric.
- UpdateSinkRequest — Class in namespace Google\Cloud\Logging\V2
- The parameters to
UpdateSink. - AlertPolicyServiceGrpcClient::UpdateAlertPolicy() — Method in class AlertPolicyServiceGrpcClient
- Updates an alerting policy. You can either replace the entire policy with
a new one or replace only certain fields in the current alerting policy by
specifying the fields to be updated via
updateMask. Returns the updated alerting policy. - GroupServiceGrpcClient::UpdateGroup() — Method in class GroupServiceGrpcClient
- Updates an existing group.
- NotificationChannelServiceGrpcClient::UpdateNotificationChannel() — Method in class NotificationChannelServiceGrpcClient
- Updates a notification channel. Fields not specified in the field mask remain unchanged.
- UpdateAlertPolicyRequest — Class in namespace Google\Cloud\Monitoring\V3
- The protocol for the
UpdateAlertPolicyrequest. - UpdateGroupRequest — Class in namespace Google\Cloud\Monitoring\V3
- The
UpdateGrouprequest. - UpdateNotificationChannelRequest — Class in namespace Google\Cloud\Monitoring\V3
- The
UpdateNotificationChannelrequest. - UpdateUptimeCheckConfigRequest — Class in namespace Google\Cloud\Monitoring\V3
- The protocol for the
UpdateUptimeCheckConfigrequest. - UptimeCheckConfig — Class in namespace Google\Cloud\Monitoring\V3
- This message configures which resources and services to monitor for availability.
- UptimeCheckConfig_ContentMatcher — Class in namespace Google\Cloud\Monitoring\V3
- Used to perform string matching. Currently, this matches on the exact content. In the future, it can be expanded to allow for regular expressions and more complex matching.
- UptimeCheckConfig_HttpCheck — Class in namespace Google\Cloud\Monitoring\V3
- Information involved in an HTTP/HTTPS uptime check request.
- UptimeCheckConfig_HttpCheck_BasicAuthentication — Class in namespace Google\Cloud\Monitoring\V3
- A type of authentication to perform against the specified resource or URL that uses username and password.
- UptimeCheckConfig_InternalChecker — Class in namespace Google\Cloud\Monitoring\V3
- Nimbus InternalCheckers.
- UptimeCheckConfig_ResourceGroup — Class in namespace Google\Cloud\Monitoring\V3
- The resource submessage for group checks. It can be used instead of a monitored resource, when multiple resources are being monitored.
- UptimeCheckConfig_TcpCheck — Class in namespace Google\Cloud\Monitoring\V3
- Information required for a TCP uptime check request.
- UptimeCheckIp — Class in namespace Google\Cloud\Monitoring\V3
- Contains the region, location, and list of IP addresses where checkers in the location run from.
- UptimeCheckRegion — Class in namespace Google\Cloud\Monitoring\V3
- The regions from which an uptime check can be run.
- UptimeCheckServiceGrpcClient — Class in namespace Google\Cloud\Monitoring\V3
- The UptimeCheckService API is used to manage (list, create, delete, edit) uptime check configurations in the Stackdriver Monitoring product. An uptime check is a piece of configuration that determines which resources and services to monitor for availability. These configurations can also be configured interactively by navigating to the [Cloud Console] (http://console.cloud.google.com), selecting the appropriate project, clicking on "Monitoring" on the left-hand side to navigate to Stackdriver, and then clicking on "Uptime".
- UptimeCheckServiceGrpcClient::UpdateUptimeCheckConfig() — Method in class UptimeCheckServiceGrpcClient
- Updates an uptime check configuration. You can either replace the entire
configuration with a new one or replace only certain fields in the current
configuration by specifying the fields to be updated via
"updateMask". - OsLoginServiceGrpcClient::UpdateSshPublicKey() — Method in class OsLoginServiceGrpcClient
- Updates an SSH public key and returns the profile information. This method supports patch semantics.
- UpdateSshPublicKeyRequest — Class in namespace Google\Cloud\OsLogin\V1beta
- A request message for updating an SSH public key.
- PublisherGrpcClient::UpdateTopic() — Method in class PublisherGrpcClient
- Updates an existing topic. Note that certain properties of a topic are not modifiable. Options settings follow the style guide: NOTE: The style guide requires body: "topic" instead of body: "*".
- SubscriberGrpcClient::UpdateSubscription() — Method in class SubscriberGrpcClient
- Updates an existing subscription. Note that certain properties of a subscription, such as its topic, are not modifiable.
- SubscriberGrpcClient::UpdateSnapshot() — Method in class SubscriberGrpcClient
- Updates an existing snapshot. Note that certain properties of a snapshot are not modifiable.
- UpdateSnapshotRequest — Class in namespace Google\Cloud\PubSub\V1
- Request for the UpdateSnapshot method.
- UpdateSubscriptionRequest — Class in namespace Google\Cloud\PubSub\V1
- Request for the UpdateSubscription method.
- UpdateTopicRequest — Class in namespace Google\Cloud\PubSub\V1
- Request for the UpdateTopic method.
- CloudRedisGrpcClient::UpdateInstance() — Method in class CloudRedisGrpcClient
- Updates the metadata and configuration of a specific Redis instance.
- UpdateInstanceRequest — Class in namespace Google\Cloud\Redis\V1beta1
- Request for [UpdateInstance][google.cloud.redis.v1beta1.CloudRedis.UpdateInstance].
- DatabaseAdminGrpcClient::UpdateDatabaseDdl() — Method in class DatabaseAdminGrpcClient
- Updates the schema of a Cloud Spanner database by
creating/altering/dropping tables, columns, indexes, etc. The returned
[long-running operation][google.longrunning.Operation] will have a name of
the format
<database_name>/operations/<operation_id>and can be used to track execution of the schema change(s). The [metadata][google.longrunning.Operation.metadata] field type is [UpdateDatabaseDdlMetadata][google.spanner.admin.database.v1.UpdateDatabaseDdlMetadata]. The operation has no response. - UpdateDatabaseDdlMetadata — Class in namespace Google\Cloud\Spanner\Admin\Database\V1
- Metadata type for the operation returned by [UpdateDatabaseDdl][google.spanner.admin.database.v1.DatabaseAdmin.UpdateDatabaseDdl].
- UpdateDatabaseDdlRequest — Class in namespace Google\Cloud\Spanner\Admin\Database\V1
- Enqueues the given DDL statements to be applied, in order but not
necessarily all at once, to the database schema at some point (or
points) in the future. The server checks that the statements
are executable (syntactically valid, name tables that exist, etc.)
before enqueueing them, but they may still fail upon
later execution (e.g., if a statement from another batch of
statements is applied first and it conflicts in some way, or if
there is some data-related problem like a
NULLvalue in a column to whichNOT NULLwould be added). If a statement fails, all subsequent statements in the batch are automatically cancelled. - InstanceAdminGrpcClient::UpdateInstance() — Method in class InstanceAdminGrpcClient
- Updates an instance, and begins allocating or releasing resources
as requested. The returned [long-running
operation][google.longrunning.Operation] can be used to track the
progress of updating the instance. If the named instance does not
exist, returns
NOT_FOUND. - UpdateInstanceMetadata — Class in namespace Google\Cloud\Spanner\Admin\Instance\V1
- Metadata type for the operation returned by [UpdateInstance][google.spanner.admin.instance.v1.InstanceAdmin.UpdateInstance].
- UpdateInstanceRequest — Class in namespace Google\Cloud\Spanner\Admin\Instance\V1
- The request for [UpdateInstance][google.spanner.admin.instance.v1.InstanceAdmin.UpdateInstance].
- CloudTasksGrpcClient::UpdateQueue() — Method in class CloudTasksGrpcClient
- Updates a queue.
- UpdateQueueRequest — Class in namespace Google\Cloud\Tasks\V2beta2
- Request message for [UpdateQueue][google.cloud.tasks.v2beta2.CloudTasks.UpdateQueue].
V
- $Parser#version — Property in class Parser
- ValidationException — Class in namespace Google\ApiCore
- ValidationException represents a local error (i.e. not during an RPC call).
- ValidationTrait — Class in namespace Google\ApiCore
- ValidationTrait::validate() — Method in class ValidationTrait
- ValidationTrait::validateNotNull() — Method in class ValidationTrait
- ValueRange — Class in namespace Google\Cloud\Bigtable\V2
- Specifies a contiguous range of raw byte values.
- Variable — Class in namespace Google\Cloud\Debugger\V2
- Represents a variable or an argument possibly of a compound object type.
- Value — Class in namespace Google\Cloud\Dlp\V2
- Set of primitive values supported by the system.
- ValueFrequency — Class in namespace Google\Cloud\Dlp\V2
- A value of a field, including its frequency.
- Value — Class in namespace Google\Cloud\Firestore\V1beta1
- A message that can hold any of the supported value types.
- $Value#value_type — Property in class Value
- NotificationChannelServiceGrpcClient::VerifyNotificationChannel() — Method in class NotificationChannelServiceGrpcClient
- Verifies a
NotificationChannelby proving receipt of the code delivered to the channel as a result of callingSendNotificationChannelVerificationCode. - $TypedValue#value — Property in class TypedValue
- VerifyNotificationChannelRequest — Class in namespace Google\Cloud\Monitoring\V3
- The
VerifyNotificationChannelrequest. - $AttributeValue#value — Property in class AttributeValue
- $Span_TimeEvent#value — Property in class Span_TimeEvent
- VideoAnnotationProgress — Class in namespace Google\Cloud\VideoIntelligence\V1
- Annotation progress for a single video.
- VideoAnnotationResults — Class in namespace Google\Cloud\VideoIntelligence\V1
- Annotation results for a single video.
- VideoContext — Class in namespace Google\Cloud\VideoIntelligence\V1
- Video context and/or feature-specific parameters.
- VideoIntelligenceServiceGrpcClient — Class in namespace Google\Cloud\VideoIntelligence\V1
- Service that implements Google Cloud Video Intelligence API.
- VideoSegment — Class in namespace Google\Cloud\VideoIntelligence\V1
- Video segment.
- VideoAnnotationProgress — Class in namespace Google\Cloud\VideoIntelligence\V1beta1
- Annotation progress for a single video.
- VideoAnnotationResults — Class in namespace Google\Cloud\VideoIntelligence\V1beta1
- Annotation results for a single video.
- VideoContext — Class in namespace Google\Cloud\VideoIntelligence\V1beta1
- Video context and/or feature-specific parameters.
- VideoIntelligenceServiceGrpcClient — Class in namespace Google\Cloud\VideoIntelligence\V1beta1
- Service that implements Google Cloud Video Intelligence API.
- VideoSegment — Class in namespace Google\Cloud\VideoIntelligence\V1beta1
- Video segment.
- VideoAnnotationProgress — Class in namespace Google\Cloud\VideoIntelligence\V1beta2
- Annotation progress for a single video.
- VideoAnnotationResults — Class in namespace Google\Cloud\VideoIntelligence\V1beta2
- Annotation results for a single video.
- VideoContext — Class in namespace Google\Cloud\VideoIntelligence\V1beta2
- Video context and/or feature-specific parameters.
- VideoIntelligenceServiceGrpcClient — Class in namespace Google\Cloud\VideoIntelligence\V1beta2
- Service that implements Google Cloud Video Intelligence API.
- VideoSegment — Class in namespace Google\Cloud\VideoIntelligence\V1beta2
- Video segment.
- Vertex — Class in namespace Google\Cloud\Vision\V1
- A vertex represents a 2D point in the image.
W
- BidiStream::write() — Method in class BidiStream
- Write request to the server.
- BidiStream::writeAll() — Method in class BidiStream
- Write all requests in $requests.
- Call::withMessage() — Method in class Call
- ClientStream::write() — Method in class ClientStream
- Write request to the server.
- ClientStream::writeAllAndReadResponse() — Method in class ClientStream
- Write all data in $dataArray and read the response from the server, completing the streaming call.
- RetrySettings::with() — Method in class RetrySettings
- Creates a new instance of RetrySettings that updates the settings in the existing instance with the settings specified in the $settings parameter.
- MockBidiStreamingCall::write() — Method in class MockBidiStreamingCall
- Save the request object, to be retrieved via getReceivedCalls()
- MockBidiStreamingCall::writesDone() — Method in class MockBidiStreamingCall
- Set writesDone to true
- MockClientStreamingCall::wait() — Method in class MockClientStreamingCall
- Immediately return the preset response object and status.
- MockClientStreamingCall::write() — Method in class MockClientStreamingCall
- Save the request object, to be retrieved via getReceivedCalls()
- MockUnaryCall::wait() — Method in class MockUnaryCall
- Immediately return the preset response object and status.
- WebhookRequest — Class in namespace Google\Cloud\Dialogflow\V2
- The request message for a webhook call.
- WebhookResponse — Class in namespace Google\Cloud\Dialogflow\V2
- The response message for a webhook call.
- FirestoreGrpcClient::Write() — Method in class FirestoreGrpcClient
- Streams batches of document updates and deletes, in order.
- Write — Class in namespace Google\Cloud\Firestore\V1beta1
- A write on a document.
- WriteRequest — Class in namespace Google\Cloud\Firestore\V1beta1
- The request for [Firestore.Write][google.firestore.v1beta1.Firestore.Write].
- WriteResponse — Class in namespace Google\Cloud\Firestore\V1beta1
- The response for [Firestore.Write][google.firestore.v1beta1.Firestore.Write].
- WriteResult — Class in namespace Google\Cloud\Firestore\V1beta1
- The result of applying a write.
- LoggingServiceV2GrpcClient::WriteLogEntries() — Method in class LoggingServiceV2GrpcClient
Log entry resources
- WriteLogEntriesPartialErrors — Class in namespace Google\Cloud\Logging\V2
- Error details for WriteLogEntries with partial success.
- WriteLogEntriesRequest — Class in namespace Google\Cloud\Logging\V2
- The parameters to WriteLogEntries.
- WriteLogEntriesResponse — Class in namespace Google\Cloud\Logging\V2
- Result returned from WriteLogEntries.
- WordInfo — Class in namespace Google\Cloud\Speech\V1
- Word-specific information for recognized words. Word information is only
included in the response when certain request parameters are set, such
as
enable_word_time_offsets. - WordInfo — Class in namespace Google\Cloud\Speech\V1p1beta1
- Word-specific information for recognized words.
- WebDetection — Class in namespace Google\Cloud\Vision\V1
- Relevant information for the image from the Internet.
- WebDetectionParams — Class in namespace Google\Cloud\Vision\V1
- Parameters for web detection request.
- WebDetection_WebEntity — Class in namespace Google\Cloud\Vision\V1
- Entity deduced from similar images on the Internet.
- WebDetection_WebImage — Class in namespace Google\Cloud\Vision\V1
- Metadata for online images.
- WebDetection_WebLabel — Class in namespace Google\Cloud\Vision\V1
- Label to provide extra metadata for the web detection.
- WebDetection_WebPage — Class in namespace Google\Cloud\Vision\V1
- Metadata for web pages.
- Word — Class in namespace Google\Cloud\Vision\V1
- A word representation.
X
- $ParserRange#x — Property in class ParserRange
- X509CertificateDetails — Class in namespace Google\Cloud\Iot\V1
- Details of an X.509 certificate. For informational purposes only.
Y
- $Parser#yy — Property in class Parser
- $ParserRange#y — Property in class ParserRange
- YarnApplication — Class in namespace Google\Cloud\Dataproc\V1
- A YARN application created by a job. Application information is a subset of
org.apache.hadoop.yarn.proto.YarnProtos.ApplicationReportProto. - YarnApplication_State — Class in namespace Google\Cloud\Dataproc\V1
- The application state, corresponding to
YarnProtos.YarnApplicationStateProto.
Z
- ZoneMetadata — Class in namespace Google\Cloud\Redis\V1beta1
- Defines specific information for a particular zone. Currently empty and reserved for future use only.
_
- AgentHeaderDescriptor::__construct() — Method in class AgentHeaderDescriptor
- ApiException::__construct() — Method in class ApiException
- ApiException constructor.
- ApiException::__toString() — Method in class ApiException
- String representation of ApiException
- BidiStream::__construct() — Method in class BidiStream
- BidiStream constructor.
- Call::__construct() — Method in class Call
- ClientStream::__construct() — Method in class ClientStream
- ClientStream constructor.
- CredentialsWrapper::__construct() — Method in class CredentialsWrapper
- CredentialsWrapper constructor.
- FixedSizeCollection::__construct() — Method in class FixedSizeCollection
- FixedSizeCollection constructor.
- LexerConditions::__construct() — Method in class LexerConditions
- LexerError::__construct() — Method in class LexerError
- Parser::__construct() — Method in class Parser
- ParserAction::__construct() — Method in class ParserAction
- ParserCachedAction::__construct() — Method in class ParserCachedAction
- ParserError::__construct() — Method in class ParserError
- ParserLocation::__construct() — Method in class ParserLocation
- ParserLocation::__clone() — Method in class ParserLocation
- ParserProduction::__construct() — Method in class ParserProduction
- ParserRange::__construct() — Method in class ParserRange
- ParserState::__construct() — Method in class ParserState
- ParserSymbol::__construct() — Method in class ParserSymbol
- ParserValue::__clone() — Method in class ParserValue
- Segment::__construct() — Method in class Segment
- OperationsGapicClient::__construct() — Method in class OperationsGapicClient
- Constructor.
- AgentHeaderMiddleware::__construct() — Method in class AgentHeaderMiddleware
- AgentHeaderMiddleware::__invoke() — Method in class AgentHeaderMiddleware
- CredentialsWrapperMiddleware::__construct() — Method in class CredentialsWrapperMiddleware
- CredentialsWrapperMiddleware::__invoke() — Method in class CredentialsWrapperMiddleware
- FixedHeaderMiddleware::__construct() — Method in class FixedHeaderMiddleware
- FixedHeaderMiddleware::__invoke() — Method in class FixedHeaderMiddleware
- OperationsMiddleware::__construct() — Method in class OperationsMiddleware
- OperationsMiddleware::__invoke() — Method in class OperationsMiddleware
- OptionsFilterMiddleware::__construct() — Method in class OptionsFilterMiddleware
- OptionsFilterMiddleware::__invoke() — Method in class OptionsFilterMiddleware
- PagedMiddleware::__construct() — Method in class PagedMiddleware
- PagedMiddleware::__invoke() — Method in class PagedMiddleware
- ResponseMetadataMiddleware::__construct() — Method in class ResponseMetadataMiddleware
- ResponseMetadataMiddleware::__invoke() — Method in class ResponseMetadataMiddleware
- RetryMiddleware::__construct() — Method in class RetryMiddleware
- RetryMiddleware::__invoke() — Method in class RetryMiddleware
- OperationResponse::__construct() — Method in class OperationResponse
- OperationResponse constructor.
- Page::__construct() — Method in class Page
- Page constructor.
- PageStreamingDescriptor::__construct() — Method in class PageStreamingDescriptor
- PagedListResponse::__construct() — Method in class PagedListResponse
- PagedListResponse constructor.
- Parser::__construct() — Method in class Parser
- Parser constructor.
- PathTemplate::__construct() — Method in class PathTemplate
- PathTemplate constructor.
- PathTemplate::__toString() — Method in class PathTemplate
- RequestBuilder::__construct() — Method in class RequestBuilder
- RequestParamsHeaderDescriptor::__construct() — Method in class RequestParamsHeaderDescriptor
- RequestParamsHeaderDescriptor constructor.
- RetrySettings::__construct() — Method in class RetrySettings
- Constructs an instance.
- Serializer::__construct() — Method in class Serializer
- Serializer constructor.
- ServerStream::__construct() — Method in class ServerStream
- ServerStream constructor.
- MockBidiStreamingCall::__construct() — Method in class MockBidiStreamingCall
- MockBidiStreamingCall constructor.
- MockClientStreamingCall::__construct() — Method in class MockClientStreamingCall
- MockClientStreamingCall constructor.
- MockGrpcTransport::__construct() — Method in class MockGrpcTransport
- MockGrpcTransport::_simpleRequest() — Method in class MockGrpcTransport
- MockGrpcTransport::_clientStreamRequest() — Method in class MockGrpcTransport
- MockGrpcTransport::_serverStreamRequest() — Method in class MockGrpcTransport
- MockGrpcTransport::_bidiRequest() — Method in class MockGrpcTransport
- MockRequest::__construct() — Method in class MockRequest
- MockRequestBody::__construct() — Method in class MockRequestBody
- MockResponse::__construct() — Method in class MockResponse
- MockServerStreamingCall::__construct() — Method in class MockServerStreamingCall
- MockServerStreamingCall constructor.
- MockStatus::__construct() — Method in class MockStatus
- MockStubTrait::__construct() — Method in class MockStubTrait
- MockStubTrait::_simpleRequest() — Method in class MockStubTrait
- Overrides the _simpleRequest method in \Grpc\BaseStub (https://github.com/grpc/grpc/blob/master/src/php/lib/Grpc/BaseStub.php) Returns a MockUnaryCall object that will return the first item from $responses
- MockStubTrait::_clientStreamRequest() — Method in class MockStubTrait
- Overrides the _clientStreamRequest method in \Grpc\BaseStub (https://github.com/grpc/grpc/blob/master/src/php/lib/Grpc/BaseStub.php) Returns a MockClientStreamingCall object that will return the first item from $responses
- MockStubTrait::_serverStreamRequest() — Method in class MockStubTrait
- Overrides the _serverStreamRequest method in \Grpc\BaseStub (https://github.com/grpc/grpc/blob/master/src/php/lib/Grpc/BaseStub.php) Returns a MockServerStreamingCall object that will stream items from $responses, and return a final status of $serverStreamingStatus.
- MockStubTrait::_bidiRequest() — Method in class MockStubTrait
- Overrides the _bidiRequest method in \Grpc\BaseStub (https://github.com/grpc/grpc/blob/master/src/php/lib/Grpc/BaseStub.php) Returns a MockBidiStreamingCall object that will stream items from $responses, and return a final status of $serverStreamingStatus.
- MockTransport::__call() — Method in class MockTransport
- MockUnaryCall::__construct() — Method in class MockUnaryCall
- MockUnaryCall constructor.
- ReceivedRequest::__construct() — Method in class ReceivedRequest
- RestTransport::__construct() — Method in class RestTransport
- Advice::__construct() — Method in class Advice
- AuthProvider::__construct() — Method in class AuthProvider
- AuthRequirement::__construct() — Method in class AuthRequirement
- Authentication::__construct() — Method in class Authentication
- AuthenticationRule::__construct() — Method in class AuthenticationRule
- AuthorizationConfig::__construct() — Method in class AuthorizationConfig
- Backend::__construct() — Method in class Backend
- BackendRule::__construct() — Method in class BackendRule
- Billing::__construct() — Method in class Billing
- Billing_BillingDestination::__construct() — Method in class Billing_BillingDestination
- ConfigChange::__construct() — Method in class ConfigChange
- Context::__construct() — Method in class Context
- ContextRule::__construct() — Method in class ContextRule
- Control::__construct() — Method in class Control
- CustomHttpPattern::__construct() — Method in class CustomHttpPattern
- Distribution::__construct() — Method in class Distribution
- Distribution_BucketOptions::__construct() — Method in class Distribution_BucketOptions
- Distribution_BucketOptions_Explicit::__construct() — Method in class Distribution_BucketOptions_Explicit
- Distribution_BucketOptions_Exponential::__construct() — Method in class Distribution_BucketOptions_Exponential
- Distribution_BucketOptions_Linear::__construct() — Method in class Distribution_BucketOptions_Linear
- Distribution_Range::__construct() — Method in class Distribution_Range
- Documentation::__construct() — Method in class Documentation
- DocumentationRule::__construct() — Method in class DocumentationRule
- Endpoint::__construct() — Method in class Endpoint
- Experimental::__construct() — Method in class Experimental
- Http::__construct() — Method in class Http
- HttpBody::__construct() — Method in class HttpBody
- HttpRule::__construct() — Method in class HttpRule
- LabelDescriptor::__construct() — Method in class LabelDescriptor
- LogDescriptor::__construct() — Method in class LogDescriptor
- Logging::__construct() — Method in class Logging
- Logging_LoggingDestination::__construct() — Method in class Logging_LoggingDestination
- Metric::__construct() — Method in class Metric
- MetricDescriptor::__construct() — Method in class MetricDescriptor
- MetricRule::__construct() — Method in class MetricRule
- MonitoredResource::__construct() — Method in class MonitoredResource
- MonitoredResourceDescriptor::__construct() — Method in class MonitoredResourceDescriptor
- Monitoring::__construct() — Method in class Monitoring
- Monitoring_MonitoringDestination::__construct() — Method in class Monitoring_MonitoringDestination
- OAuthRequirements::__construct() — Method in class OAuthRequirements
- Page::__construct() — Method in class Page
- ProjectProperties::__construct() — Method in class ProjectProperties
- Property::__construct() — Method in class Property
- Quota::__construct() — Method in class Quota
- QuotaLimit::__construct() — Method in class QuotaLimit
- Service::__construct() — Method in class Service
- SourceInfo::__construct() — Method in class SourceInfo
- SystemParameter::__construct() — Method in class SystemParameter
- SystemParameterRule::__construct() — Method in class SystemParameterRule
- SystemParameters::__construct() — Method in class SystemParameters
- Usage::__construct() — Method in class Usage
- UsageRule::__construct() — Method in class UsageRule
- AuditLog::__construct() — Method in class AuditLog
- AuthenticationInfo::__construct() — Method in class AuthenticationInfo
- AuthorizationInfo::__construct() — Method in class AuthorizationInfo
- RequestMetadata::__construct() — Method in class RequestMetadata
- CheckValidCredsRequest::__construct() — Method in class CheckValidCredsRequest
- CheckValidCredsResponse::__construct() — Method in class CheckValidCredsResponse
- CreateTransferConfigRequest::__construct() — Method in class CreateTransferConfigRequest
- DataSource::__construct() — Method in class DataSource
- DataSourceParameter::__construct() — Method in class DataSourceParameter
- DataTransferServiceGrpcClient::__construct() — Method in class DataTransferServiceGrpcClient
- DeleteTransferConfigRequest::__construct() — Method in class DeleteTransferConfigRequest
- DeleteTransferRunRequest::__construct() — Method in class DeleteTransferRunRequest
- GetDataSourceRequest::__construct() — Method in class GetDataSourceRequest
- GetTransferConfigRequest::__construct() — Method in class GetTransferConfigRequest
- GetTransferRunRequest::__construct() — Method in class GetTransferRunRequest
- ListDataSourcesRequest::__construct() — Method in class ListDataSourcesRequest
- ListDataSourcesResponse::__construct() — Method in class ListDataSourcesResponse
- ListTransferConfigsRequest::__construct() — Method in class ListTransferConfigsRequest
- ListTransferConfigsResponse::__construct() — Method in class ListTransferConfigsResponse
- ListTransferLogsRequest::__construct() — Method in class ListTransferLogsRequest
- ListTransferLogsResponse::__construct() — Method in class ListTransferLogsResponse
- ListTransferRunsRequest::__construct() — Method in class ListTransferRunsRequest
- ListTransferRunsResponse::__construct() — Method in class ListTransferRunsResponse
- ScheduleTransferRunsRequest::__construct() — Method in class ScheduleTransferRunsRequest
- ScheduleTransferRunsResponse::__construct() — Method in class ScheduleTransferRunsResponse
- TransferConfig::__construct() — Method in class TransferConfig
- TransferMessage::__construct() — Method in class TransferMessage
- TransferRun::__construct() — Method in class TransferRun
- UpdateTransferConfigRequest::__construct() — Method in class UpdateTransferConfigRequest
- AppProfile::__construct() — Method in class AppProfile
- AppProfile_MultiClusterRoutingUseAny::__construct() — Method in class AppProfile_MultiClusterRoutingUseAny
- AppProfile_SingleClusterRouting::__construct() — Method in class AppProfile_SingleClusterRouting
- BigtableInstanceAdminGrpcClient::__construct() — Method in class BigtableInstanceAdminGrpcClient
- BigtableTableAdminGrpcClient::__construct() — Method in class BigtableTableAdminGrpcClient
- CheckConsistencyRequest::__construct() — Method in class CheckConsistencyRequest
- CheckConsistencyResponse::__construct() — Method in class CheckConsistencyResponse
- Cluster::__construct() — Method in class Cluster
- ColumnFamily::__construct() — Method in class ColumnFamily
- CreateAppProfileRequest::__construct() — Method in class CreateAppProfileRequest
- CreateClusterMetadata::__construct() — Method in class CreateClusterMetadata
- CreateClusterRequest::__construct() — Method in class CreateClusterRequest
- CreateInstanceMetadata::__construct() — Method in class CreateInstanceMetadata
- CreateInstanceRequest::__construct() — Method in class CreateInstanceRequest
- CreateTableFromSnapshotMetadata::__construct() — Method in class CreateTableFromSnapshotMetadata
- CreateTableFromSnapshotRequest::__construct() — Method in class CreateTableFromSnapshotRequest
- CreateTableRequest::__construct() — Method in class CreateTableRequest
- CreateTableRequest_Split::__construct() — Method in class CreateTableRequest_Split
- DeleteAppProfileRequest::__construct() — Method in class DeleteAppProfileRequest
- DeleteClusterRequest::__construct() — Method in class DeleteClusterRequest
- DeleteInstanceRequest::__construct() — Method in class DeleteInstanceRequest
- DeleteSnapshotRequest::__construct() — Method in class DeleteSnapshotRequest
- DeleteTableRequest::__construct() — Method in class DeleteTableRequest
- DropRowRangeRequest::__construct() — Method in class DropRowRangeRequest
- GcRule::__construct() — Method in class GcRule
- GcRule_Intersection::__construct() — Method in class GcRule_Intersection
- GcRule_Union::__construct() — Method in class GcRule_Union
- GenerateConsistencyTokenRequest::__construct() — Method in class GenerateConsistencyTokenRequest
- GenerateConsistencyTokenResponse::__construct() — Method in class GenerateConsistencyTokenResponse
- GetAppProfileRequest::__construct() — Method in class GetAppProfileRequest
- GetClusterRequest::__construct() — Method in class GetClusterRequest
- GetInstanceRequest::__construct() — Method in class GetInstanceRequest
- GetSnapshotRequest::__construct() — Method in class GetSnapshotRequest
- GetTableRequest::__construct() — Method in class GetTableRequest
- Instance::__construct() — Method in class Instance
- ListAppProfilesRequest::__construct() — Method in class ListAppProfilesRequest
- ListAppProfilesResponse::__construct() — Method in class ListAppProfilesResponse
- ListClustersRequest::__construct() — Method in class ListClustersRequest
- ListClustersResponse::__construct() — Method in class ListClustersResponse
- ListInstancesRequest::__construct() — Method in class ListInstancesRequest
- ListInstancesResponse::__construct() — Method in class ListInstancesResponse
- ListSnapshotsRequest::__construct() — Method in class ListSnapshotsRequest
- ListSnapshotsResponse::__construct() — Method in class ListSnapshotsResponse
- ListTablesRequest::__construct() — Method in class ListTablesRequest
- ListTablesResponse::__construct() — Method in class ListTablesResponse
- ModifyColumnFamiliesRequest::__construct() — Method in class ModifyColumnFamiliesRequest
- ModifyColumnFamiliesRequest_Modification::__construct() — Method in class ModifyColumnFamiliesRequest_Modification
- PartialUpdateInstanceRequest::__construct() — Method in class PartialUpdateInstanceRequest
- Snapshot::__construct() — Method in class Snapshot
- SnapshotTableMetadata::__construct() — Method in class SnapshotTableMetadata
- SnapshotTableRequest::__construct() — Method in class SnapshotTableRequest
- Table::__construct() — Method in class Table
- Table_ClusterState::__construct() — Method in class Table_ClusterState
- UpdateAppProfileMetadata::__construct() — Method in class UpdateAppProfileMetadata
- UpdateAppProfileRequest::__construct() — Method in class UpdateAppProfileRequest
- UpdateClusterMetadata::__construct() — Method in class UpdateClusterMetadata
- UpdateInstanceMetadata::__construct() — Method in class UpdateInstanceMetadata
- BigtableGrpcClient::__construct() — Method in class BigtableGrpcClient
- Cell::__construct() — Method in class Cell
- CheckAndMutateRowRequest::__construct() — Method in class CheckAndMutateRowRequest
- CheckAndMutateRowResponse::__construct() — Method in class CheckAndMutateRowResponse
- Column::__construct() — Method in class Column
- ColumnRange::__construct() — Method in class ColumnRange
- Family::__construct() — Method in class Family
- MutateRowRequest::__construct() — Method in class MutateRowRequest
- MutateRowResponse::__construct() — Method in class MutateRowResponse
- MutateRowsRequest::__construct() — Method in class MutateRowsRequest
- MutateRowsRequest_Entry::__construct() — Method in class MutateRowsRequest_Entry
- MutateRowsResponse::__construct() — Method in class MutateRowsResponse
- MutateRowsResponse_Entry::__construct() — Method in class MutateRowsResponse_Entry
- Mutation::__construct() — Method in class Mutation
- Mutation_DeleteFromColumn::__construct() — Method in class Mutation_DeleteFromColumn
- Mutation_DeleteFromFamily::__construct() — Method in class Mutation_DeleteFromFamily
- Mutation_DeleteFromRow::__construct() — Method in class Mutation_DeleteFromRow
- Mutation_SetCell::__construct() — Method in class Mutation_SetCell
- ReadModifyWriteRowRequest::__construct() — Method in class ReadModifyWriteRowRequest
- ReadModifyWriteRowResponse::__construct() — Method in class ReadModifyWriteRowResponse
- ReadModifyWriteRule::__construct() — Method in class ReadModifyWriteRule
- ReadRowsRequest::__construct() — Method in class ReadRowsRequest
- ReadRowsResponse::__construct() — Method in class ReadRowsResponse
- ReadRowsResponse_CellChunk::__construct() — Method in class ReadRowsResponse_CellChunk
- Row::__construct() — Method in class Row
- RowFilter::__construct() — Method in class RowFilter
- RowFilter_Chain::__construct() — Method in class RowFilter_Chain
- RowFilter_Condition::__construct() — Method in class RowFilter_Condition
- RowFilter_Interleave::__construct() — Method in class RowFilter_Interleave
- RowRange::__construct() — Method in class RowRange
- RowSet::__construct() — Method in class RowSet
- SampleRowKeysRequest::__construct() — Method in class SampleRowKeysRequest
- SampleRowKeysResponse::__construct() — Method in class SampleRowKeysResponse
- TimestampRange::__construct() — Method in class TimestampRange
- ValueRange::__construct() — Method in class ValueRange
- AcceleratorConfig::__construct() — Method in class AcceleratorConfig
- AddonsConfig::__construct() — Method in class AddonsConfig
- AutoUpgradeOptions::__construct() — Method in class AutoUpgradeOptions
- CancelOperationRequest::__construct() — Method in class CancelOperationRequest
- ClientCertificateConfig::__construct() — Method in class ClientCertificateConfig
- Cluster::__construct() — Method in class Cluster
- ClusterManagerGrpcClient::__construct() — Method in class ClusterManagerGrpcClient
- ClusterUpdate::__construct() — Method in class ClusterUpdate
- CompleteIPRotationRequest::__construct() — Method in class CompleteIPRotationRequest
- CreateClusterRequest::__construct() — Method in class CreateClusterRequest
- CreateNodePoolRequest::__construct() — Method in class CreateNodePoolRequest
- DailyMaintenanceWindow::__construct() — Method in class DailyMaintenanceWindow
- DeleteClusterRequest::__construct() — Method in class DeleteClusterRequest
- DeleteNodePoolRequest::__construct() — Method in class DeleteNodePoolRequest
- GetClusterRequest::__construct() — Method in class GetClusterRequest
- GetNodePoolRequest::__construct() — Method in class GetNodePoolRequest
- GetOperationRequest::__construct() — Method in class GetOperationRequest
- GetServerConfigRequest::__construct() — Method in class GetServerConfigRequest
- HorizontalPodAutoscaling::__construct() — Method in class HorizontalPodAutoscaling
- HttpLoadBalancing::__construct() — Method in class HttpLoadBalancing
- IPAllocationPolicy::__construct() — Method in class IPAllocationPolicy
- KubernetesDashboard::__construct() — Method in class KubernetesDashboard
- LegacyAbac::__construct() — Method in class LegacyAbac
- ListClustersRequest::__construct() — Method in class ListClustersRequest
- ListClustersResponse::__construct() — Method in class ListClustersResponse
- ListNodePoolsRequest::__construct() — Method in class ListNodePoolsRequest
- ListNodePoolsResponse::__construct() — Method in class ListNodePoolsResponse
- ListOperationsRequest::__construct() — Method in class ListOperationsRequest
- ListOperationsResponse::__construct() — Method in class ListOperationsResponse
- MaintenancePolicy::__construct() — Method in class MaintenancePolicy
- MaintenanceWindow::__construct() — Method in class MaintenanceWindow
- MasterAuth::__construct() — Method in class MasterAuth
- MasterAuthorizedNetworksConfig::__construct() — Method in class MasterAuthorizedNetworksConfig
- MasterAuthorizedNetworksConfig_CidrBlock::__construct() — Method in class MasterAuthorizedNetworksConfig_CidrBlock
- NetworkPolicy::__construct() — Method in class NetworkPolicy
- NetworkPolicyConfig::__construct() — Method in class NetworkPolicyConfig
- NodeConfig::__construct() — Method in class NodeConfig
- NodeManagement::__construct() — Method in class NodeManagement
- NodePool::__construct() — Method in class NodePool
- NodePoolAutoscaling::__construct() — Method in class NodePoolAutoscaling
- Operation::__construct() — Method in class Operation
- RollbackNodePoolUpgradeRequest::__construct() — Method in class RollbackNodePoolUpgradeRequest
- ServerConfig::__construct() — Method in class ServerConfig
- SetAddonsConfigRequest::__construct() — Method in class SetAddonsConfigRequest
- SetLabelsRequest::__construct() — Method in class SetLabelsRequest
- SetLegacyAbacRequest::__construct() — Method in class SetLegacyAbacRequest
- SetLocationsRequest::__construct() — Method in class SetLocationsRequest
- SetLoggingServiceRequest::__construct() — Method in class SetLoggingServiceRequest
- SetMaintenancePolicyRequest::__construct() — Method in class SetMaintenancePolicyRequest
- SetMasterAuthRequest::__construct() — Method in class SetMasterAuthRequest
- SetMonitoringServiceRequest::__construct() — Method in class SetMonitoringServiceRequest
- SetNetworkPolicyRequest::__construct() — Method in class SetNetworkPolicyRequest
- SetNodePoolAutoscalingRequest::__construct() — Method in class SetNodePoolAutoscalingRequest
- SetNodePoolManagementRequest::__construct() — Method in class SetNodePoolManagementRequest
- SetNodePoolSizeRequest::__construct() — Method in class SetNodePoolSizeRequest
- StartIPRotationRequest::__construct() — Method in class StartIPRotationRequest
- UpdateClusterRequest::__construct() — Method in class UpdateClusterRequest
- UpdateMasterRequest::__construct() — Method in class UpdateMasterRequest
- UpdateNodePoolRequest::__construct() — Method in class UpdateNodePoolRequest
- AcceleratorConfig::__construct() — Method in class AcceleratorConfig
- CancelJobRequest::__construct() — Method in class CancelJobRequest
- Cluster::__construct() — Method in class Cluster
- ClusterConfig::__construct() — Method in class ClusterConfig
- ClusterControllerGrpcClient::__construct() — Method in class ClusterControllerGrpcClient
- ClusterMetrics::__construct() — Method in class ClusterMetrics
- ClusterOperationMetadata::__construct() — Method in class ClusterOperationMetadata
- ClusterOperationStatus::__construct() — Method in class ClusterOperationStatus
- ClusterStatus::__construct() — Method in class ClusterStatus
- CreateClusterRequest::__construct() — Method in class CreateClusterRequest
- DeleteClusterRequest::__construct() — Method in class DeleteClusterRequest
- DeleteJobRequest::__construct() — Method in class DeleteJobRequest
- DiagnoseClusterRequest::__construct() — Method in class DiagnoseClusterRequest
- DiagnoseClusterResults::__construct() — Method in class DiagnoseClusterResults
- DiskConfig::__construct() — Method in class DiskConfig
- GceClusterConfig::__construct() — Method in class GceClusterConfig
- GetClusterRequest::__construct() — Method in class GetClusterRequest
- GetJobRequest::__construct() — Method in class GetJobRequest
- HadoopJob::__construct() — Method in class HadoopJob
- HiveJob::__construct() — Method in class HiveJob
- InstanceGroupConfig::__construct() — Method in class InstanceGroupConfig
- Job::__construct() — Method in class Job
- JobControllerGrpcClient::__construct() — Method in class JobControllerGrpcClient
- JobPlacement::__construct() — Method in class JobPlacement
- JobReference::__construct() — Method in class JobReference
- JobScheduling::__construct() — Method in class JobScheduling
- JobStatus::__construct() — Method in class JobStatus
- ListClustersRequest::__construct() — Method in class ListClustersRequest
- ListClustersResponse::__construct() — Method in class ListClustersResponse
- ListJobsRequest::__construct() — Method in class ListJobsRequest
- ListJobsResponse::__construct() — Method in class ListJobsResponse
- LoggingConfig::__construct() — Method in class LoggingConfig
- ManagedGroupConfig::__construct() — Method in class ManagedGroupConfig
- NodeInitializationAction::__construct() — Method in class NodeInitializationAction
- PigJob::__construct() — Method in class PigJob
- PySparkJob::__construct() — Method in class PySparkJob
- QueryList::__construct() — Method in class QueryList
- SoftwareConfig::__construct() — Method in class SoftwareConfig
- SparkJob::__construct() — Method in class SparkJob
- SparkSqlJob::__construct() — Method in class SparkSqlJob
- SubmitJobRequest::__construct() — Method in class SubmitJobRequest
- UpdateClusterRequest::__construct() — Method in class UpdateClusterRequest
- UpdateJobRequest::__construct() — Method in class UpdateJobRequest
- YarnApplication::__construct() — Method in class YarnApplication
- Breakpoint::__construct() — Method in class Breakpoint
- Controller2GrpcClient::__construct() — Method in class Controller2GrpcClient
- Debuggee::__construct() — Method in class Debuggee
- Debugger2GrpcClient::__construct() — Method in class Debugger2GrpcClient
- DeleteBreakpointRequest::__construct() — Method in class DeleteBreakpointRequest
- FormatMessage::__construct() — Method in class FormatMessage
- GetBreakpointRequest::__construct() — Method in class GetBreakpointRequest
- GetBreakpointResponse::__construct() — Method in class GetBreakpointResponse
- ListActiveBreakpointsRequest::__construct() — Method in class ListActiveBreakpointsRequest
- ListActiveBreakpointsResponse::__construct() — Method in class ListActiveBreakpointsResponse
- ListBreakpointsRequest::__construct() — Method in class ListBreakpointsRequest
- ListBreakpointsRequest_BreakpointActionValue::__construct() — Method in class ListBreakpointsRequest_BreakpointActionValue
- ListBreakpointsResponse::__construct() — Method in class ListBreakpointsResponse
- ListDebuggeesRequest::__construct() — Method in class ListDebuggeesRequest
- ListDebuggeesResponse::__construct() — Method in class ListDebuggeesResponse
- RegisterDebuggeeRequest::__construct() — Method in class RegisterDebuggeeRequest
- RegisterDebuggeeResponse::__construct() — Method in class RegisterDebuggeeResponse
- SetBreakpointRequest::__construct() — Method in class SetBreakpointRequest
- SetBreakpointResponse::__construct() — Method in class SetBreakpointResponse
- SourceLocation::__construct() — Method in class SourceLocation
- StackFrame::__construct() — Method in class StackFrame
- StatusMessage::__construct() — Method in class StatusMessage
- UpdateActiveBreakpointRequest::__construct() — Method in class UpdateActiveBreakpointRequest
- UpdateActiveBreakpointResponse::__construct() — Method in class UpdateActiveBreakpointResponse
- Variable::__construct() — Method in class Variable
- AliasContext::__construct() — Method in class AliasContext
- CloudRepoSourceContext::__construct() — Method in class CloudRepoSourceContext
- CloudWorkspaceId::__construct() — Method in class CloudWorkspaceId
- CloudWorkspaceSourceContext::__construct() — Method in class CloudWorkspaceSourceContext
- ExtendedSourceContext::__construct() — Method in class ExtendedSourceContext
- GerritSourceContext::__construct() — Method in class GerritSourceContext
- GitSourceContext::__construct() — Method in class GitSourceContext
- ProjectRepoId::__construct() — Method in class ProjectRepoId
- RepoId::__construct() — Method in class RepoId
- SourceContext::__construct() — Method in class SourceContext
- Agent::__construct() — Method in class Agent
- AgentsGrpcClient::__construct() — Method in class AgentsGrpcClient
- BatchCreateEntitiesRequest::__construct() — Method in class BatchCreateEntitiesRequest
- BatchDeleteEntitiesRequest::__construct() — Method in class BatchDeleteEntitiesRequest
- BatchDeleteEntityTypesRequest::__construct() — Method in class BatchDeleteEntityTypesRequest
- BatchDeleteIntentsRequest::__construct() — Method in class BatchDeleteIntentsRequest
- BatchUpdateEntitiesRequest::__construct() — Method in class BatchUpdateEntitiesRequest
- BatchUpdateEntityTypesRequest::__construct() — Method in class BatchUpdateEntityTypesRequest
- BatchUpdateEntityTypesResponse::__construct() — Method in class BatchUpdateEntityTypesResponse
- BatchUpdateIntentsRequest::__construct() — Method in class BatchUpdateIntentsRequest
- BatchUpdateIntentsResponse::__construct() — Method in class BatchUpdateIntentsResponse
- Context::__construct() — Method in class Context
- ContextsGrpcClient::__construct() — Method in class ContextsGrpcClient
- CreateContextRequest::__construct() — Method in class CreateContextRequest
- CreateEntityTypeRequest::__construct() — Method in class CreateEntityTypeRequest
- CreateIntentRequest::__construct() — Method in class CreateIntentRequest
- CreateSessionEntityTypeRequest::__construct() — Method in class CreateSessionEntityTypeRequest
- DeleteAllContextsRequest::__construct() — Method in class DeleteAllContextsRequest
- DeleteContextRequest::__construct() — Method in class DeleteContextRequest
- DeleteEntityTypeRequest::__construct() — Method in class DeleteEntityTypeRequest
- DeleteIntentRequest::__construct() — Method in class DeleteIntentRequest
- DeleteSessionEntityTypeRequest::__construct() — Method in class DeleteSessionEntityTypeRequest
- DetectIntentRequest::__construct() — Method in class DetectIntentRequest
- DetectIntentResponse::__construct() — Method in class DetectIntentResponse
- EntityType::__construct() — Method in class EntityType
- EntityTypeBatch::__construct() — Method in class EntityTypeBatch
- EntityType_Entity::__construct() — Method in class EntityType_Entity
- EntityTypesGrpcClient::__construct() — Method in class EntityTypesGrpcClient
- EventInput::__construct() — Method in class EventInput
- ExportAgentRequest::__construct() — Method in class ExportAgentRequest
- ExportAgentResponse::__construct() — Method in class ExportAgentResponse
- GetAgentRequest::__construct() — Method in class GetAgentRequest
- GetContextRequest::__construct() — Method in class GetContextRequest
- GetEntityTypeRequest::__construct() — Method in class GetEntityTypeRequest
- GetIntentRequest::__construct() — Method in class GetIntentRequest
- GetSessionEntityTypeRequest::__construct() — Method in class GetSessionEntityTypeRequest
- ImportAgentRequest::__construct() — Method in class ImportAgentRequest
- InputAudioConfig::__construct() — Method in class InputAudioConfig
- Intent::__construct() — Method in class Intent
- IntentBatch::__construct() — Method in class IntentBatch
- Intent_FollowupIntentInfo::__construct() — Method in class Intent_FollowupIntentInfo
- Intent_Message::__construct() — Method in class Intent_Message
- Intent_Message_BasicCard::__construct() — Method in class Intent_Message_BasicCard
- Intent_Message_BasicCard_Button::__construct() — Method in class Intent_Message_BasicCard_Button
- Intent_Message_BasicCard_Button_OpenUriAction::__construct() — Method in class Intent_Message_BasicCard_Button_OpenUriAction
- Intent_Message_Card::__construct() — Method in class Intent_Message_Card
- Intent_Message_Card_Button::__construct() — Method in class Intent_Message_Card_Button
- Intent_Message_CarouselSelect::__construct() — Method in class Intent_Message_CarouselSelect
- Intent_Message_CarouselSelect_Item::__construct() — Method in class Intent_Message_CarouselSelect_Item
- Intent_Message_Image::__construct() — Method in class Intent_Message_Image
- Intent_Message_LinkOutSuggestion::__construct() — Method in class Intent_Message_LinkOutSuggestion
- Intent_Message_ListSelect::__construct() — Method in class Intent_Message_ListSelect
- Intent_Message_ListSelect_Item::__construct() — Method in class Intent_Message_ListSelect_Item
- Intent_Message_QuickReplies::__construct() — Method in class Intent_Message_QuickReplies
- Intent_Message_SelectItemInfo::__construct() — Method in class Intent_Message_SelectItemInfo
- Intent_Message_SimpleResponse::__construct() — Method in class Intent_Message_SimpleResponse
- Intent_Message_SimpleResponses::__construct() — Method in class Intent_Message_SimpleResponses
- Intent_Message_Suggestion::__construct() — Method in class Intent_Message_Suggestion
- Intent_Message_Suggestions::__construct() — Method in class Intent_Message_Suggestions
- Intent_Message_Text::__construct() — Method in class Intent_Message_Text
- Intent_Parameter::__construct() — Method in class Intent_Parameter
- Intent_TrainingPhrase::__construct() — Method in class Intent_TrainingPhrase
- Intent_TrainingPhrase_Part::__construct() — Method in class Intent_TrainingPhrase_Part
- IntentsGrpcClient::__construct() — Method in class IntentsGrpcClient
- ListContextsRequest::__construct() — Method in class ListContextsRequest
- ListContextsResponse::__construct() — Method in class ListContextsResponse
- ListEntityTypesRequest::__construct() — Method in class ListEntityTypesRequest
- ListEntityTypesResponse::__construct() — Method in class ListEntityTypesResponse
- ListIntentsRequest::__construct() — Method in class ListIntentsRequest
- ListIntentsResponse::__construct() — Method in class ListIntentsResponse
- ListSessionEntityTypesRequest::__construct() — Method in class ListSessionEntityTypesRequest
- ListSessionEntityTypesResponse::__construct() — Method in class ListSessionEntityTypesResponse
- OriginalDetectIntentRequest::__construct() — Method in class OriginalDetectIntentRequest
- QueryInput::__construct() — Method in class QueryInput
- QueryParameters::__construct() — Method in class QueryParameters
- QueryResult::__construct() — Method in class QueryResult
- RestoreAgentRequest::__construct() — Method in class RestoreAgentRequest
- SearchAgentsRequest::__construct() — Method in class SearchAgentsRequest
- SearchAgentsResponse::__construct() — Method in class SearchAgentsResponse
- SessionEntityType::__construct() — Method in class SessionEntityType
- SessionEntityTypesGrpcClient::__construct() — Method in class SessionEntityTypesGrpcClient
- SessionsGrpcClient::__construct() — Method in class SessionsGrpcClient
- StreamingDetectIntentRequest::__construct() — Method in class StreamingDetectIntentRequest
- StreamingDetectIntentResponse::__construct() — Method in class StreamingDetectIntentResponse
- StreamingRecognitionResult::__construct() — Method in class StreamingRecognitionResult
- TextInput::__construct() — Method in class TextInput
- TrainAgentRequest::__construct() — Method in class TrainAgentRequest
- UpdateContextRequest::__construct() — Method in class UpdateContextRequest
- UpdateEntityTypeRequest::__construct() — Method in class UpdateEntityTypeRequest
- UpdateIntentRequest::__construct() — Method in class UpdateIntentRequest
- UpdateSessionEntityTypeRequest::__construct() — Method in class UpdateSessionEntityTypeRequest
- WebhookRequest::__construct() — Method in class WebhookRequest
- WebhookResponse::__construct() — Method in class WebhookResponse
- Action::__construct() — Method in class Action
- Action_PublishSummaryToCscc::__construct() — Method in class Action_PublishSummaryToCscc
- Action_PublishToPubSub::__construct() — Method in class Action_PublishToPubSub
- Action_SaveFindings::__construct() — Method in class Action_SaveFindings
- AnalyzeDataSourceRiskDetails::__construct() — Method in class AnalyzeDataSourceRiskDetails
- AnalyzeDataSourceRiskDetails_CategoricalStatsResult::__construct() — Method in class AnalyzeDataSourceRiskDetails_CategoricalStatsResult
- AnalyzeDataSourceRiskDetails_CategoricalStatsResult_CategoricalStatsHistogramBucket::__construct() — Method in class AnalyzeDataSourceRiskDetails_CategoricalStatsResult_CategoricalStatsHistogramBucket
- AnalyzeDataSourceRiskDetails_KAnonymityResult::__construct() — Method in class AnalyzeDataSourceRiskDetails_KAnonymityResult
- AnalyzeDataSourceRiskDetails_KAnonymityResult_KAnonymityEquivalenceClass::__construct() — Method in class AnalyzeDataSourceRiskDetails_KAnonymityResult_KAnonymityEquivalenceClass
- AnalyzeDataSourceRiskDetails_KAnonymityResult_KAnonymityHistogramBucket::__construct() — Method in class AnalyzeDataSourceRiskDetails_KAnonymityResult_KAnonymityHistogramBucket
- AnalyzeDataSourceRiskDetails_KMapEstimationResult::__construct() — Method in class AnalyzeDataSourceRiskDetails_KMapEstimationResult
- AnalyzeDataSourceRiskDetails_KMapEstimationResult_KMapEstimationHistogramBucket::__construct() — Method in class AnalyzeDataSourceRiskDetails_KMapEstimationResult_KMapEstimationHistogramBucket
- AnalyzeDataSourceRiskDetails_KMapEstimationResult_KMapEstimationQuasiIdValues::__construct() — Method in class AnalyzeDataSourceRiskDetails_KMapEstimationResult_KMapEstimationQuasiIdValues
- AnalyzeDataSourceRiskDetails_LDiversityResult::__construct() — Method in class AnalyzeDataSourceRiskDetails_LDiversityResult
- AnalyzeDataSourceRiskDetails_LDiversityResult_LDiversityEquivalenceClass::__construct() — Method in class AnalyzeDataSourceRiskDetails_LDiversityResult_LDiversityEquivalenceClass
- AnalyzeDataSourceRiskDetails_LDiversityResult_LDiversityHistogramBucket::__construct() — Method in class AnalyzeDataSourceRiskDetails_LDiversityResult_LDiversityHistogramBucket
- AnalyzeDataSourceRiskDetails_NumericalStatsResult::__construct() — Method in class AnalyzeDataSourceRiskDetails_NumericalStatsResult
- BigQueryKey::__construct() — Method in class BigQueryKey
- BigQueryOptions::__construct() — Method in class BigQueryOptions
- BigQueryTable::__construct() — Method in class BigQueryTable
- BoundingBox::__construct() — Method in class BoundingBox
- BucketingConfig::__construct() — Method in class BucketingConfig
- BucketingConfig_Bucket::__construct() — Method in class BucketingConfig_Bucket
- ByteContentItem::__construct() — Method in class ByteContentItem
- CancelDlpJobRequest::__construct() — Method in class CancelDlpJobRequest
- CharacterMaskConfig::__construct() — Method in class CharacterMaskConfig
- CharsToIgnore::__construct() — Method in class CharsToIgnore
- CloudStorageOptions::__construct() — Method in class CloudStorageOptions
- CloudStorageOptions_FileSet::__construct() — Method in class CloudStorageOptions_FileSet
- CloudStoragePath::__construct() — Method in class CloudStoragePath
- Color::__construct() — Method in class Color
- ContentItem::__construct() — Method in class ContentItem
- ContentLocation::__construct() — Method in class ContentLocation
- CreateDeidentifyTemplateRequest::__construct() — Method in class CreateDeidentifyTemplateRequest
- CreateDlpJobRequest::__construct() — Method in class CreateDlpJobRequest
- CreateInspectTemplateRequest::__construct() — Method in class CreateInspectTemplateRequest
- CreateJobTriggerRequest::__construct() — Method in class CreateJobTriggerRequest
- CryptoHashConfig::__construct() — Method in class CryptoHashConfig
- CryptoKey::__construct() — Method in class CryptoKey
- CryptoReplaceFfxFpeConfig::__construct() — Method in class CryptoReplaceFfxFpeConfig
- CustomInfoType::__construct() — Method in class CustomInfoType
- CustomInfoType_DetectionRule::__construct() — Method in class CustomInfoType_DetectionRule
- CustomInfoType_DetectionRule_HotwordRule::__construct() — Method in class CustomInfoType_DetectionRule_HotwordRule
- CustomInfoType_DetectionRule_LikelihoodAdjustment::__construct() — Method in class CustomInfoType_DetectionRule_LikelihoodAdjustment
- CustomInfoType_DetectionRule_Proximity::__construct() — Method in class CustomInfoType_DetectionRule_Proximity
- CustomInfoType_Dictionary::__construct() — Method in class CustomInfoType_Dictionary
- CustomInfoType_Dictionary_WordList::__construct() — Method in class CustomInfoType_Dictionary_WordList
- CustomInfoType_Regex::__construct() — Method in class CustomInfoType_Regex
- CustomInfoType_SurrogateType::__construct() — Method in class CustomInfoType_SurrogateType
- DatastoreKey::__construct() — Method in class DatastoreKey
- DatastoreOptions::__construct() — Method in class DatastoreOptions
- DateShiftConfig::__construct() — Method in class DateShiftConfig
- DateTime::__construct() — Method in class DateTime
- DateTime_TimeZone::__construct() — Method in class DateTime_TimeZone
- DeidentifyConfig::__construct() — Method in class DeidentifyConfig
- DeidentifyContentRequest::__construct() — Method in class DeidentifyContentRequest
- DeidentifyContentResponse::__construct() — Method in class DeidentifyContentResponse
- DeidentifyTemplate::__construct() — Method in class DeidentifyTemplate
- DeleteDeidentifyTemplateRequest::__construct() — Method in class DeleteDeidentifyTemplateRequest
- DeleteDlpJobRequest::__construct() — Method in class DeleteDlpJobRequest
- DeleteInspectTemplateRequest::__construct() — Method in class DeleteInspectTemplateRequest
- DeleteJobTriggerRequest::__construct() — Method in class DeleteJobTriggerRequest
- DlpJob::__construct() — Method in class DlpJob
- DlpServiceGrpcClient::__construct() — Method in class DlpServiceGrpcClient
- DocumentLocation::__construct() — Method in class DocumentLocation
- EntityId::__construct() — Method in class EntityId
- Error::__construct() — Method in class Error
- FieldId::__construct() — Method in class FieldId
- FieldTransformation::__construct() — Method in class FieldTransformation
- Finding::__construct() — Method in class Finding
- FixedSizeBucketingConfig::__construct() — Method in class FixedSizeBucketingConfig
- GetDeidentifyTemplateRequest::__construct() — Method in class GetDeidentifyTemplateRequest
- GetDlpJobRequest::__construct() — Method in class GetDlpJobRequest
- GetInspectTemplateRequest::__construct() — Method in class GetInspectTemplateRequest
- GetJobTriggerRequest::__construct() — Method in class GetJobTriggerRequest
- ImageLocation::__construct() — Method in class ImageLocation
- InfoType::__construct() — Method in class InfoType
- InfoTypeDescription::__construct() — Method in class InfoTypeDescription
- InfoTypeStats::__construct() — Method in class InfoTypeStats
- InfoTypeTransformations::__construct() — Method in class InfoTypeTransformations
- InfoTypeTransformations_InfoTypeTransformation::__construct() — Method in class InfoTypeTransformations_InfoTypeTransformation
- InspectConfig::__construct() — Method in class InspectConfig
- InspectConfig_FindingLimits::__construct() — Method in class InspectConfig_FindingLimits
- InspectConfig_FindingLimits_InfoTypeLimit::__construct() — Method in class InspectConfig_FindingLimits_InfoTypeLimit
- InspectContentRequest::__construct() — Method in class InspectContentRequest
- InspectContentResponse::__construct() — Method in class InspectContentResponse
- InspectDataSourceDetails::__construct() — Method in class InspectDataSourceDetails
- InspectDataSourceDetails_RequestedOptions::__construct() — Method in class InspectDataSourceDetails_RequestedOptions
- InspectDataSourceDetails_Result::__construct() — Method in class InspectDataSourceDetails_Result
- InspectJobConfig::__construct() — Method in class InspectJobConfig
- InspectResult::__construct() — Method in class InspectResult
- InspectTemplate::__construct() — Method in class InspectTemplate
- JobTrigger::__construct() — Method in class JobTrigger
- JobTrigger_Trigger::__construct() — Method in class JobTrigger_Trigger
- Key::__construct() — Method in class Key
- Key_PathElement::__construct() — Method in class Key_PathElement
- KindExpression::__construct() — Method in class KindExpression
- KmsWrappedCryptoKey::__construct() — Method in class KmsWrappedCryptoKey
- ListDeidentifyTemplatesRequest::__construct() — Method in class ListDeidentifyTemplatesRequest
- ListDeidentifyTemplatesResponse::__construct() — Method in class ListDeidentifyTemplatesResponse
- ListDlpJobsRequest::__construct() — Method in class ListDlpJobsRequest
- ListDlpJobsResponse::__construct() — Method in class ListDlpJobsResponse
- ListInfoTypesRequest::__construct() — Method in class ListInfoTypesRequest
- ListInfoTypesResponse::__construct() — Method in class ListInfoTypesResponse
- ListInspectTemplatesRequest::__construct() — Method in class ListInspectTemplatesRequest
- ListInspectTemplatesResponse::__construct() — Method in class ListInspectTemplatesResponse
- ListJobTriggersRequest::__construct() — Method in class ListJobTriggersRequest
- ListJobTriggersResponse::__construct() — Method in class ListJobTriggersResponse
- Location::__construct() — Method in class Location
- OutputStorageConfig::__construct() — Method in class OutputStorageConfig
- PartitionId::__construct() — Method in class PartitionId
- PrimitiveTransformation::__construct() — Method in class PrimitiveTransformation
- PrivacyMetric::__construct() — Method in class PrivacyMetric
- PrivacyMetric_CategoricalStatsConfig::__construct() — Method in class PrivacyMetric_CategoricalStatsConfig
- PrivacyMetric_KAnonymityConfig::__construct() — Method in class PrivacyMetric_KAnonymityConfig
- PrivacyMetric_KMapEstimationConfig::__construct() — Method in class PrivacyMetric_KMapEstimationConfig
- PrivacyMetric_KMapEstimationConfig_AuxiliaryTable::__construct() — Method in class PrivacyMetric_KMapEstimationConfig_AuxiliaryTable
- PrivacyMetric_KMapEstimationConfig_AuxiliaryTable_QuasiIdField::__construct() — Method in class PrivacyMetric_KMapEstimationConfig_AuxiliaryTable_QuasiIdField
- PrivacyMetric_KMapEstimationConfig_TaggedField::__construct() — Method in class PrivacyMetric_KMapEstimationConfig_TaggedField
- PrivacyMetric_LDiversityConfig::__construct() — Method in class PrivacyMetric_LDiversityConfig
- PrivacyMetric_NumericalStatsConfig::__construct() — Method in class PrivacyMetric_NumericalStatsConfig
- QuoteInfo::__construct() — Method in class QuoteInfo
- Range::__construct() — Method in class Range
- RecordCondition::__construct() — Method in class RecordCondition
- RecordCondition_Condition::__construct() — Method in class RecordCondition_Condition
- RecordCondition_Conditions::__construct() — Method in class RecordCondition_Conditions
- RecordCondition_Expressions::__construct() — Method in class RecordCondition_Expressions
- RecordKey::__construct() — Method in class RecordKey
- RecordLocation::__construct() — Method in class RecordLocation
- RecordSuppression::__construct() — Method in class RecordSuppression
- RecordTransformations::__construct() — Method in class RecordTransformations
- RedactConfig::__construct() — Method in class RedactConfig
- RedactImageRequest::__construct() — Method in class RedactImageRequest
- RedactImageRequest_ImageRedactionConfig::__construct() — Method in class RedactImageRequest_ImageRedactionConfig
- RedactImageResponse::__construct() — Method in class RedactImageResponse
- ReidentifyContentRequest::__construct() — Method in class ReidentifyContentRequest
- ReidentifyContentResponse::__construct() — Method in class ReidentifyContentResponse
- ReplaceValueConfig::__construct() — Method in class ReplaceValueConfig
- ReplaceWithInfoTypeConfig::__construct() — Method in class ReplaceWithInfoTypeConfig
- RiskAnalysisJobConfig::__construct() — Method in class RiskAnalysisJobConfig
- Schedule::__construct() — Method in class Schedule
- StorageConfig::__construct() — Method in class StorageConfig
- StorageConfig_TimespanConfig::__construct() — Method in class StorageConfig_TimespanConfig
- Table::__construct() — Method in class Table
- TableLocation::__construct() — Method in class TableLocation
- Table_Row::__construct() — Method in class Table_Row
- TimePartConfig::__construct() — Method in class TimePartConfig
- TransformationOverview::__construct() — Method in class TransformationOverview
- TransformationSummary::__construct() — Method in class TransformationSummary
- TransformationSummary_SummaryResult::__construct() — Method in class TransformationSummary_SummaryResult
- TransientCryptoKey::__construct() — Method in class TransientCryptoKey
- UnwrappedCryptoKey::__construct() — Method in class UnwrappedCryptoKey
- UpdateDeidentifyTemplateRequest::__construct() — Method in class UpdateDeidentifyTemplateRequest
- UpdateInspectTemplateRequest::__construct() — Method in class UpdateInspectTemplateRequest
- UpdateJobTriggerRequest::__construct() — Method in class UpdateJobTriggerRequest
- Value::__construct() — Method in class Value
- ValueFrequency::__construct() — Method in class ValueFrequency
- DeleteEventsRequest::__construct() — Method in class DeleteEventsRequest
- DeleteEventsResponse::__construct() — Method in class DeleteEventsResponse
- ErrorContext::__construct() — Method in class ErrorContext
- ErrorEvent::__construct() — Method in class ErrorEvent
- ErrorGroup::__construct() — Method in class ErrorGroup
- ErrorGroupServiceGrpcClient::__construct() — Method in class ErrorGroupServiceGrpcClient
- ErrorGroupStats::__construct() — Method in class ErrorGroupStats
- ErrorStatsServiceGrpcClient::__construct() — Method in class ErrorStatsServiceGrpcClient
- GetGroupRequest::__construct() — Method in class GetGroupRequest
- HttpRequestContext::__construct() — Method in class HttpRequestContext
- ListEventsRequest::__construct() — Method in class ListEventsRequest
- ListEventsResponse::__construct() — Method in class ListEventsResponse
- ListGroupStatsRequest::__construct() — Method in class ListGroupStatsRequest
- ListGroupStatsResponse::__construct() — Method in class ListGroupStatsResponse
- QueryTimeRange::__construct() — Method in class QueryTimeRange
- ReportErrorEventRequest::__construct() — Method in class ReportErrorEventRequest
- ReportErrorEventResponse::__construct() — Method in class ReportErrorEventResponse
- ReportErrorsServiceGrpcClient::__construct() — Method in class ReportErrorsServiceGrpcClient
- ReportedErrorEvent::__construct() — Method in class ReportedErrorEvent
- ServiceContext::__construct() — Method in class ServiceContext
- ServiceContextFilter::__construct() — Method in class ServiceContextFilter
- SourceLocation::__construct() — Method in class SourceLocation
- TimedCount::__construct() — Method in class TimedCount
- TrackingIssue::__construct() — Method in class TrackingIssue
- UpdateGroupRequest::__construct() — Method in class UpdateGroupRequest
- ArrayValue::__construct() — Method in class ArrayValue
- BatchGetDocumentsRequest::__construct() — Method in class BatchGetDocumentsRequest
- BatchGetDocumentsResponse::__construct() — Method in class BatchGetDocumentsResponse
- BeginTransactionRequest::__construct() — Method in class BeginTransactionRequest
- BeginTransactionResponse::__construct() — Method in class BeginTransactionResponse
- CommitRequest::__construct() — Method in class CommitRequest
- CommitResponse::__construct() — Method in class CommitResponse
- CreateDocumentRequest::__construct() — Method in class CreateDocumentRequest
- Cursor::__construct() — Method in class Cursor
- DeleteDocumentRequest::__construct() — Method in class DeleteDocumentRequest
- Document::__construct() — Method in class Document
- DocumentChange::__construct() — Method in class DocumentChange
- DocumentDelete::__construct() — Method in class DocumentDelete
- DocumentMask::__construct() — Method in class DocumentMask
- DocumentRemove::__construct() — Method in class DocumentRemove
- DocumentTransform::__construct() — Method in class DocumentTransform
- DocumentTransform_FieldTransform::__construct() — Method in class DocumentTransform_FieldTransform
- ExistenceFilter::__construct() — Method in class ExistenceFilter
- FirestoreGrpcClient::__construct() — Method in class FirestoreGrpcClient
- GetDocumentRequest::__construct() — Method in class GetDocumentRequest
- ListCollectionIdsRequest::__construct() — Method in class ListCollectionIdsRequest
- ListCollectionIdsResponse::__construct() — Method in class ListCollectionIdsResponse
- ListDocumentsRequest::__construct() — Method in class ListDocumentsRequest
- ListDocumentsResponse::__construct() — Method in class ListDocumentsResponse
- ListenRequest::__construct() — Method in class ListenRequest
- ListenResponse::__construct() — Method in class ListenResponse
- MapValue::__construct() — Method in class MapValue
- Precondition::__construct() — Method in class Precondition
- RollbackRequest::__construct() — Method in class RollbackRequest
- RunQueryRequest::__construct() — Method in class RunQueryRequest
- RunQueryResponse::__construct() — Method in class RunQueryResponse
- StructuredQuery::__construct() — Method in class StructuredQuery
- StructuredQuery_CollectionSelector::__construct() — Method in class StructuredQuery_CollectionSelector
- StructuredQuery_CompositeFilter::__construct() — Method in class StructuredQuery_CompositeFilter
- StructuredQuery_FieldFilter::__construct() — Method in class StructuredQuery_FieldFilter
- StructuredQuery_FieldReference::__construct() — Method in class StructuredQuery_FieldReference
- StructuredQuery_Filter::__construct() — Method in class StructuredQuery_Filter
- StructuredQuery_Order::__construct() — Method in class StructuredQuery_Order
- StructuredQuery_Projection::__construct() — Method in class StructuredQuery_Projection
- StructuredQuery_UnaryFilter::__construct() — Method in class StructuredQuery_UnaryFilter
- Target::__construct() — Method in class Target
- TargetChange::__construct() — Method in class TargetChange
- Target_DocumentsTarget::__construct() — Method in class Target_DocumentsTarget
- Target_QueryTarget::__construct() — Method in class Target_QueryTarget
- TransactionOptions::__construct() — Method in class TransactionOptions
- TransactionOptions_ReadOnly::__construct() — Method in class TransactionOptions_ReadOnly
- TransactionOptions_ReadWrite::__construct() — Method in class TransactionOptions_ReadWrite
- UpdateDocumentRequest::__construct() — Method in class UpdateDocumentRequest
- Value::__construct() — Method in class Value
- Write::__construct() — Method in class Write
- WriteRequest::__construct() — Method in class WriteRequest
- WriteResponse::__construct() — Method in class WriteResponse
- WriteResult::__construct() — Method in class WriteResult
- Binding::__construct() — Method in class Binding
- BindingDelta::__construct() — Method in class BindingDelta
- GetIamPolicyRequest::__construct() — Method in class GetIamPolicyRequest
- IAMPolicyGrpcClient::__construct() — Method in class IAMPolicyGrpcClient
- Policy::__construct() — Method in class Policy
- PolicyDelta::__construct() — Method in class PolicyDelta
- SetIamPolicyRequest::__construct() — Method in class SetIamPolicyRequest
- TestIamPermissionsRequest::__construct() — Method in class TestIamPermissionsRequest
- TestIamPermissionsResponse::__construct() — Method in class TestIamPermissionsResponse
- CreateDeviceRegistryRequest::__construct() — Method in class CreateDeviceRegistryRequest
- CreateDeviceRequest::__construct() — Method in class CreateDeviceRequest
- DeleteDeviceRegistryRequest::__construct() — Method in class DeleteDeviceRegistryRequest
- DeleteDeviceRequest::__construct() — Method in class DeleteDeviceRequest
- Device::__construct() — Method in class Device
- DeviceConfig::__construct() — Method in class DeviceConfig
- DeviceCredential::__construct() — Method in class DeviceCredential
- DeviceManagerGrpcClient::__construct() — Method in class DeviceManagerGrpcClient
- DeviceRegistry::__construct() — Method in class DeviceRegistry
- DeviceState::__construct() — Method in class DeviceState
- EventNotificationConfig::__construct() — Method in class EventNotificationConfig
- GetDeviceRegistryRequest::__construct() — Method in class GetDeviceRegistryRequest
- GetDeviceRequest::__construct() — Method in class GetDeviceRequest
- HttpConfig::__construct() — Method in class HttpConfig
- ListDeviceConfigVersionsRequest::__construct() — Method in class ListDeviceConfigVersionsRequest
- ListDeviceConfigVersionsResponse::__construct() — Method in class ListDeviceConfigVersionsResponse
- ListDeviceRegistriesRequest::__construct() — Method in class ListDeviceRegistriesRequest
- ListDeviceRegistriesResponse::__construct() — Method in class ListDeviceRegistriesResponse
- ListDeviceStatesRequest::__construct() — Method in class ListDeviceStatesRequest
- ListDeviceStatesResponse::__construct() — Method in class ListDeviceStatesResponse
- ListDevicesRequest::__construct() — Method in class ListDevicesRequest
- ListDevicesResponse::__construct() — Method in class ListDevicesResponse
- ModifyCloudToDeviceConfigRequest::__construct() — Method in class ModifyCloudToDeviceConfigRequest
- MqttConfig::__construct() — Method in class MqttConfig
- PublicKeyCertificate::__construct() — Method in class PublicKeyCertificate
- PublicKeyCredential::__construct() — Method in class PublicKeyCredential
- RegistryCredential::__construct() — Method in class RegistryCredential
- StateNotificationConfig::__construct() — Method in class StateNotificationConfig
- UpdateDeviceRegistryRequest::__construct() — Method in class UpdateDeviceRegistryRequest
- UpdateDeviceRequest::__construct() — Method in class UpdateDeviceRequest
- X509CertificateDetails::__construct() — Method in class X509CertificateDetails
- AnalyzeEntitiesRequest::__construct() — Method in class AnalyzeEntitiesRequest
- AnalyzeEntitiesResponse::__construct() — Method in class AnalyzeEntitiesResponse
- AnalyzeEntitySentimentRequest::__construct() — Method in class AnalyzeEntitySentimentRequest
- AnalyzeEntitySentimentResponse::__construct() — Method in class AnalyzeEntitySentimentResponse
- AnalyzeSentimentRequest::__construct() — Method in class AnalyzeSentimentRequest
- AnalyzeSentimentResponse::__construct() — Method in class AnalyzeSentimentResponse
- AnalyzeSyntaxRequest::__construct() — Method in class AnalyzeSyntaxRequest
- AnalyzeSyntaxResponse::__construct() — Method in class AnalyzeSyntaxResponse
- AnnotateTextRequest::__construct() — Method in class AnnotateTextRequest
- AnnotateTextRequest_Features::__construct() — Method in class AnnotateTextRequest_Features
- AnnotateTextResponse::__construct() — Method in class AnnotateTextResponse
- ClassificationCategory::__construct() — Method in class ClassificationCategory
- ClassifyTextRequest::__construct() — Method in class ClassifyTextRequest
- ClassifyTextResponse::__construct() — Method in class ClassifyTextResponse
- DependencyEdge::__construct() — Method in class DependencyEdge
- Document::__construct() — Method in class Document
- Entity::__construct() — Method in class Entity
- EntityMention::__construct() — Method in class EntityMention
- LanguageServiceGrpcClient::__construct() — Method in class LanguageServiceGrpcClient
- PartOfSpeech::__construct() — Method in class PartOfSpeech
- Sentence::__construct() — Method in class Sentence
- Sentiment::__construct() — Method in class Sentiment
- TextSpan::__construct() — Method in class TextSpan
- Token::__construct() — Method in class Token
- HttpRequest::__construct() — Method in class HttpRequest
- ConfigServiceV2GrpcClient::__construct() — Method in class ConfigServiceV2GrpcClient
- CreateExclusionRequest::__construct() — Method in class CreateExclusionRequest
- CreateLogMetricRequest::__construct() — Method in class CreateLogMetricRequest
- CreateSinkRequest::__construct() — Method in class CreateSinkRequest
- DeleteExclusionRequest::__construct() — Method in class DeleteExclusionRequest
- DeleteLogMetricRequest::__construct() — Method in class DeleteLogMetricRequest
- DeleteLogRequest::__construct() — Method in class DeleteLogRequest
- DeleteSinkRequest::__construct() — Method in class DeleteSinkRequest
- GetExclusionRequest::__construct() — Method in class GetExclusionRequest
- GetLogMetricRequest::__construct() — Method in class GetLogMetricRequest
- GetSinkRequest::__construct() — Method in class GetSinkRequest
- ListExclusionsRequest::__construct() — Method in class ListExclusionsRequest
- ListExclusionsResponse::__construct() — Method in class ListExclusionsResponse
- ListLogEntriesRequest::__construct() — Method in class ListLogEntriesRequest
- ListLogEntriesResponse::__construct() — Method in class ListLogEntriesResponse
- ListLogMetricsRequest::__construct() — Method in class ListLogMetricsRequest
- ListLogMetricsResponse::__construct() — Method in class ListLogMetricsResponse
- ListLogsRequest::__construct() — Method in class ListLogsRequest
- ListLogsResponse::__construct() — Method in class ListLogsResponse
- ListMonitoredResourceDescriptorsRequest::__construct() — Method in class ListMonitoredResourceDescriptorsRequest
- ListMonitoredResourceDescriptorsResponse::__construct() — Method in class ListMonitoredResourceDescriptorsResponse
- ListSinksRequest::__construct() — Method in class ListSinksRequest
- ListSinksResponse::__construct() — Method in class ListSinksResponse
- LogEntry::__construct() — Method in class LogEntry
- LogEntryOperation::__construct() — Method in class LogEntryOperation
- LogEntrySourceLocation::__construct() — Method in class LogEntrySourceLocation
- LogExclusion::__construct() — Method in class LogExclusion
- LogMetric::__construct() — Method in class LogMetric
- LogSink::__construct() — Method in class LogSink
- LoggingServiceV2GrpcClient::__construct() — Method in class LoggingServiceV2GrpcClient
- MetricsServiceV2GrpcClient::__construct() — Method in class MetricsServiceV2GrpcClient
- UpdateExclusionRequest::__construct() — Method in class UpdateExclusionRequest
- UpdateLogMetricRequest::__construct() — Method in class UpdateLogMetricRequest
- UpdateSinkRequest::__construct() — Method in class UpdateSinkRequest
- WriteLogEntriesPartialErrors::__construct() — Method in class WriteLogEntriesPartialErrors
- WriteLogEntriesRequest::__construct() — Method in class WriteLogEntriesRequest
- WriteLogEntriesResponse::__construct() — Method in class WriteLogEntriesResponse
- Aggregation::__construct() — Method in class Aggregation
- AlertPolicy::__construct() — Method in class AlertPolicy
- AlertPolicyServiceGrpcClient::__construct() — Method in class AlertPolicyServiceGrpcClient
- AlertPolicy_Condition::__construct() — Method in class AlertPolicy_Condition
- AlertPolicy_Condition_MetricAbsence::__construct() — Method in class AlertPolicy_Condition_MetricAbsence
- AlertPolicy_Condition_MetricThreshold::__construct() — Method in class AlertPolicy_Condition_MetricThreshold
- AlertPolicy_Condition_Trigger::__construct() — Method in class AlertPolicy_Condition_Trigger
- AlertPolicy_Documentation::__construct() — Method in class AlertPolicy_Documentation
- CreateAlertPolicyRequest::__construct() — Method in class CreateAlertPolicyRequest
- CreateGroupRequest::__construct() — Method in class CreateGroupRequest
- CreateMetricDescriptorRequest::__construct() — Method in class CreateMetricDescriptorRequest
- CreateNotificationChannelRequest::__construct() — Method in class CreateNotificationChannelRequest
- CreateTimeSeriesError::__construct() — Method in class CreateTimeSeriesError
- CreateTimeSeriesRequest::__construct() — Method in class CreateTimeSeriesRequest
- CreateUptimeCheckConfigRequest::__construct() — Method in class CreateUptimeCheckConfigRequest
- DeleteAlertPolicyRequest::__construct() — Method in class DeleteAlertPolicyRequest
- DeleteGroupRequest::__construct() — Method in class DeleteGroupRequest
- DeleteMetricDescriptorRequest::__construct() — Method in class DeleteMetricDescriptorRequest
- DeleteNotificationChannelRequest::__construct() — Method in class DeleteNotificationChannelRequest
- DeleteUptimeCheckConfigRequest::__construct() — Method in class DeleteUptimeCheckConfigRequest
- GetAlertPolicyRequest::__construct() — Method in class GetAlertPolicyRequest
- GetGroupRequest::__construct() — Method in class GetGroupRequest
- GetMetricDescriptorRequest::__construct() — Method in class GetMetricDescriptorRequest
- GetMonitoredResourceDescriptorRequest::__construct() — Method in class GetMonitoredResourceDescriptorRequest
- GetNotificationChannelDescriptorRequest::__construct() — Method in class GetNotificationChannelDescriptorRequest
- GetNotificationChannelRequest::__construct() — Method in class GetNotificationChannelRequest
- GetNotificationChannelVerificationCodeRequest::__construct() — Method in class GetNotificationChannelVerificationCodeRequest
- GetNotificationChannelVerificationCodeResponse::__construct() — Method in class GetNotificationChannelVerificationCodeResponse
- GetUptimeCheckConfigRequest::__construct() — Method in class GetUptimeCheckConfigRequest
- Group::__construct() — Method in class Group
- GroupServiceGrpcClient::__construct() — Method in class GroupServiceGrpcClient
- ListAlertPoliciesRequest::__construct() — Method in class ListAlertPoliciesRequest
- ListAlertPoliciesResponse::__construct() — Method in class ListAlertPoliciesResponse
- ListGroupMembersRequest::__construct() — Method in class ListGroupMembersRequest
- ListGroupMembersResponse::__construct() — Method in class ListGroupMembersResponse
- ListGroupsRequest::__construct() — Method in class ListGroupsRequest
- ListGroupsResponse::__construct() — Method in class ListGroupsResponse
- ListMetricDescriptorsRequest::__construct() — Method in class ListMetricDescriptorsRequest
- ListMetricDescriptorsResponse::__construct() — Method in class ListMetricDescriptorsResponse
- ListMonitoredResourceDescriptorsRequest::__construct() — Method in class ListMonitoredResourceDescriptorsRequest
- ListMonitoredResourceDescriptorsResponse::__construct() — Method in class ListMonitoredResourceDescriptorsResponse
- ListNotificationChannelDescriptorsRequest::__construct() — Method in class ListNotificationChannelDescriptorsRequest
- ListNotificationChannelDescriptorsResponse::__construct() — Method in class ListNotificationChannelDescriptorsResponse
- ListNotificationChannelsRequest::__construct() — Method in class ListNotificationChannelsRequest
- ListNotificationChannelsResponse::__construct() — Method in class ListNotificationChannelsResponse
- ListTimeSeriesRequest::__construct() — Method in class ListTimeSeriesRequest
- ListTimeSeriesResponse::__construct() — Method in class ListTimeSeriesResponse
- ListUptimeCheckConfigsRequest::__construct() — Method in class ListUptimeCheckConfigsRequest
- ListUptimeCheckConfigsResponse::__construct() — Method in class ListUptimeCheckConfigsResponse
- ListUptimeCheckIpsRequest::__construct() — Method in class ListUptimeCheckIpsRequest
- ListUptimeCheckIpsResponse::__construct() — Method in class ListUptimeCheckIpsResponse
- MetricServiceGrpcClient::__construct() — Method in class MetricServiceGrpcClient
- MutationRecord::__construct() — Method in class MutationRecord
- NotificationChannel::__construct() — Method in class NotificationChannel
- NotificationChannelDescriptor::__construct() — Method in class NotificationChannelDescriptor
- NotificationChannelServiceGrpcClient::__construct() — Method in class NotificationChannelServiceGrpcClient
- Point::__construct() — Method in class Point
- SendNotificationChannelVerificationCodeRequest::__construct() — Method in class SendNotificationChannelVerificationCodeRequest
- TimeInterval::__construct() — Method in class TimeInterval
- TimeSeries::__construct() — Method in class TimeSeries
- TypedValue::__construct() — Method in class TypedValue
- UpdateAlertPolicyRequest::__construct() — Method in class UpdateAlertPolicyRequest
- UpdateGroupRequest::__construct() — Method in class UpdateGroupRequest
- UpdateNotificationChannelRequest::__construct() — Method in class UpdateNotificationChannelRequest
- UpdateUptimeCheckConfigRequest::__construct() — Method in class UpdateUptimeCheckConfigRequest
- UptimeCheckConfig::__construct() — Method in class UptimeCheckConfig
- UptimeCheckConfig_ContentMatcher::__construct() — Method in class UptimeCheckConfig_ContentMatcher
- UptimeCheckConfig_HttpCheck::__construct() — Method in class UptimeCheckConfig_HttpCheck
- UptimeCheckConfig_HttpCheck_BasicAuthentication::__construct() — Method in class UptimeCheckConfig_HttpCheck_BasicAuthentication
- UptimeCheckConfig_InternalChecker::__construct() — Method in class UptimeCheckConfig_InternalChecker
- UptimeCheckConfig_ResourceGroup::__construct() — Method in class UptimeCheckConfig_ResourceGroup
- UptimeCheckConfig_TcpCheck::__construct() — Method in class UptimeCheckConfig_TcpCheck
- UptimeCheckIp::__construct() — Method in class UptimeCheckIp
- UptimeCheckServiceGrpcClient::__construct() — Method in class UptimeCheckServiceGrpcClient
- VerifyNotificationChannelRequest::__construct() — Method in class VerifyNotificationChannelRequest
- PosixAccount::__construct() — Method in class PosixAccount
- SshPublicKey::__construct() — Method in class SshPublicKey
- DeletePosixAccountRequest::__construct() — Method in class DeletePosixAccountRequest
- DeleteSshPublicKeyRequest::__construct() — Method in class DeleteSshPublicKeyRequest
- GetLoginProfileRequest::__construct() — Method in class GetLoginProfileRequest
- GetSshPublicKeyRequest::__construct() — Method in class GetSshPublicKeyRequest
- ImportSshPublicKeyRequest::__construct() — Method in class ImportSshPublicKeyRequest
- ImportSshPublicKeyResponse::__construct() — Method in class ImportSshPublicKeyResponse
- LoginProfile::__construct() — Method in class LoginProfile
- OsLoginServiceGrpcClient::__construct() — Method in class OsLoginServiceGrpcClient
- UpdateSshPublicKeyRequest::__construct() — Method in class UpdateSshPublicKeyRequest
- AcknowledgeRequest::__construct() — Method in class AcknowledgeRequest
- CreateSnapshotRequest::__construct() — Method in class CreateSnapshotRequest
- DeleteSnapshotRequest::__construct() — Method in class DeleteSnapshotRequest
- DeleteSubscriptionRequest::__construct() — Method in class DeleteSubscriptionRequest
- DeleteTopicRequest::__construct() — Method in class DeleteTopicRequest
- GetSubscriptionRequest::__construct() — Method in class GetSubscriptionRequest
- GetTopicRequest::__construct() — Method in class GetTopicRequest
- ListSnapshotsRequest::__construct() — Method in class ListSnapshotsRequest
- ListSnapshotsResponse::__construct() — Method in class ListSnapshotsResponse
- ListSubscriptionsRequest::__construct() — Method in class ListSubscriptionsRequest
- ListSubscriptionsResponse::__construct() — Method in class ListSubscriptionsResponse
- ListTopicSubscriptionsRequest::__construct() — Method in class ListTopicSubscriptionsRequest
- ListTopicSubscriptionsResponse::__construct() — Method in class ListTopicSubscriptionsResponse
- ListTopicsRequest::__construct() — Method in class ListTopicsRequest
- ListTopicsResponse::__construct() — Method in class ListTopicsResponse
- ModifyAckDeadlineRequest::__construct() — Method in class ModifyAckDeadlineRequest
- ModifyPushConfigRequest::__construct() — Method in class ModifyPushConfigRequest
- PublishRequest::__construct() — Method in class PublishRequest
- PublishResponse::__construct() — Method in class PublishResponse
- PublisherGrpcClient::__construct() — Method in class PublisherGrpcClient
- PubsubMessage::__construct() — Method in class PubsubMessage
- PullRequest::__construct() — Method in class PullRequest
- PullResponse::__construct() — Method in class PullResponse
- PushConfig::__construct() — Method in class PushConfig
- ReceivedMessage::__construct() — Method in class ReceivedMessage
- SeekRequest::__construct() — Method in class SeekRequest
- SeekResponse::__construct() — Method in class SeekResponse
- Snapshot::__construct() — Method in class Snapshot
- StreamingPullRequest::__construct() — Method in class StreamingPullRequest
- StreamingPullResponse::__construct() — Method in class StreamingPullResponse
- SubscriberGrpcClient::__construct() — Method in class SubscriberGrpcClient
- Subscription::__construct() — Method in class Subscription
- Topic::__construct() — Method in class Topic
- UpdateSnapshotRequest::__construct() — Method in class UpdateSnapshotRequest
- UpdateSubscriptionRequest::__construct() — Method in class UpdateSubscriptionRequest
- UpdateTopicRequest::__construct() — Method in class UpdateTopicRequest
- CloudRedisGrpcClient::__construct() — Method in class CloudRedisGrpcClient
- CreateInstanceRequest::__construct() — Method in class CreateInstanceRequest
- DeleteInstanceRequest::__construct() — Method in class DeleteInstanceRequest
- GetInstanceRequest::__construct() — Method in class GetInstanceRequest
- Instance::__construct() — Method in class Instance
- ListInstancesRequest::__construct() — Method in class ListInstancesRequest
- ListInstancesResponse::__construct() — Method in class ListInstancesResponse
- LocationMetadata::__construct() — Method in class LocationMetadata
- UpdateInstanceRequest::__construct() — Method in class UpdateInstanceRequest
- ZoneMetadata::__construct() — Method in class ZoneMetadata
- CreateDatabaseMetadata::__construct() — Method in class CreateDatabaseMetadata
- CreateDatabaseRequest::__construct() — Method in class CreateDatabaseRequest
- Database::__construct() — Method in class Database
- DatabaseAdminGrpcClient::__construct() — Method in class DatabaseAdminGrpcClient
- DropDatabaseRequest::__construct() — Method in class DropDatabaseRequest
- GetDatabaseDdlRequest::__construct() — Method in class GetDatabaseDdlRequest
- GetDatabaseDdlResponse::__construct() — Method in class GetDatabaseDdlResponse
- GetDatabaseRequest::__construct() — Method in class GetDatabaseRequest
- ListDatabasesRequest::__construct() — Method in class ListDatabasesRequest
- ListDatabasesResponse::__construct() — Method in class ListDatabasesResponse
- UpdateDatabaseDdlMetadata::__construct() — Method in class UpdateDatabaseDdlMetadata
- UpdateDatabaseDdlRequest::__construct() — Method in class UpdateDatabaseDdlRequest
- CreateInstanceMetadata::__construct() — Method in class CreateInstanceMetadata
- CreateInstanceRequest::__construct() — Method in class CreateInstanceRequest
- DeleteInstanceRequest::__construct() — Method in class DeleteInstanceRequest
- GetInstanceConfigRequest::__construct() — Method in class GetInstanceConfigRequest
- GetInstanceRequest::__construct() — Method in class GetInstanceRequest
- Instance::__construct() — Method in class Instance
- InstanceAdminGrpcClient::__construct() — Method in class InstanceAdminGrpcClient
- InstanceConfig::__construct() — Method in class InstanceConfig
- ListInstanceConfigsRequest::__construct() — Method in class ListInstanceConfigsRequest
- ListInstanceConfigsResponse::__construct() — Method in class ListInstanceConfigsResponse
- ListInstancesRequest::__construct() — Method in class ListInstancesRequest
- ListInstancesResponse::__construct() — Method in class ListInstancesResponse
- UpdateInstanceMetadata::__construct() — Method in class UpdateInstanceMetadata
- UpdateInstanceRequest::__construct() — Method in class UpdateInstanceRequest
- BeginTransactionRequest::__construct() — Method in class BeginTransactionRequest
- CommitRequest::__construct() — Method in class CommitRequest
- CommitResponse::__construct() — Method in class CommitResponse
- CreateSessionRequest::__construct() — Method in class CreateSessionRequest
- DeleteSessionRequest::__construct() — Method in class DeleteSessionRequest
- ExecuteSqlRequest::__construct() — Method in class ExecuteSqlRequest
- GetSessionRequest::__construct() — Method in class GetSessionRequest
- KeyRange::__construct() — Method in class KeyRange
- KeySet::__construct() — Method in class KeySet
- ListSessionsRequest::__construct() — Method in class ListSessionsRequest
- ListSessionsResponse::__construct() — Method in class ListSessionsResponse
- Mutation::__construct() — Method in class Mutation
- Mutation_Delete::__construct() — Method in class Mutation_Delete
- Mutation_Write::__construct() — Method in class Mutation_Write
- PartialResultSet::__construct() — Method in class PartialResultSet
- Partition::__construct() — Method in class Partition
- PartitionOptions::__construct() — Method in class PartitionOptions
- PartitionQueryRequest::__construct() — Method in class PartitionQueryRequest
- PartitionReadRequest::__construct() — Method in class PartitionReadRequest
- PartitionResponse::__construct() — Method in class PartitionResponse
- PlanNode::__construct() — Method in class PlanNode
- PlanNode_ChildLink::__construct() — Method in class PlanNode_ChildLink
- PlanNode_ShortRepresentation::__construct() — Method in class PlanNode_ShortRepresentation
- QueryPlan::__construct() — Method in class QueryPlan
- ReadRequest::__construct() — Method in class ReadRequest
- ResultSet::__construct() — Method in class ResultSet
- ResultSetMetadata::__construct() — Method in class ResultSetMetadata
- ResultSetStats::__construct() — Method in class ResultSetStats
- RollbackRequest::__construct() — Method in class RollbackRequest
- Session::__construct() — Method in class Session
- SpannerGrpcClient::__construct() — Method in class SpannerGrpcClient
- StructType::__construct() — Method in class StructType
- StructType_Field::__construct() — Method in class StructType_Field
- Transaction::__construct() — Method in class Transaction
- TransactionOptions::__construct() — Method in class TransactionOptions
- TransactionOptions_ReadOnly::__construct() — Method in class TransactionOptions_ReadOnly
- TransactionOptions_ReadWrite::__construct() — Method in class TransactionOptions_ReadWrite
- TransactionSelector::__construct() — Method in class TransactionSelector
- Type::__construct() — Method in class Type
- LongRunningRecognizeMetadata::__construct() — Method in class LongRunningRecognizeMetadata
- LongRunningRecognizeRequest::__construct() — Method in class LongRunningRecognizeRequest
- LongRunningRecognizeResponse::__construct() — Method in class LongRunningRecognizeResponse
- RecognitionAudio::__construct() — Method in class RecognitionAudio
- RecognitionConfig::__construct() — Method in class RecognitionConfig
- RecognizeRequest::__construct() — Method in class RecognizeRequest
- RecognizeResponse::__construct() — Method in class RecognizeResponse
- SpeechContext::__construct() — Method in class SpeechContext
- SpeechGrpcClient::__construct() — Method in class SpeechGrpcClient
- SpeechRecognitionAlternative::__construct() — Method in class SpeechRecognitionAlternative
- SpeechRecognitionResult::__construct() — Method in class SpeechRecognitionResult
- StreamingRecognitionConfig::__construct() — Method in class StreamingRecognitionConfig
- StreamingRecognitionResult::__construct() — Method in class StreamingRecognitionResult
- StreamingRecognizeRequest::__construct() — Method in class StreamingRecognizeRequest
- StreamingRecognizeResponse::__construct() — Method in class StreamingRecognizeResponse
- WordInfo::__construct() — Method in class WordInfo
- AsyncRecognizeMetadata::__construct() — Method in class AsyncRecognizeMetadata
- AsyncRecognizeRequest::__construct() — Method in class AsyncRecognizeRequest
- AsyncRecognizeResponse::__construct() — Method in class AsyncRecognizeResponse
- RecognitionAudio::__construct() — Method in class RecognitionAudio
- RecognitionConfig::__construct() — Method in class RecognitionConfig
- SpeechContext::__construct() — Method in class SpeechContext
- SpeechGrpcClient::__construct() — Method in class SpeechGrpcClient
- SpeechRecognitionAlternative::__construct() — Method in class SpeechRecognitionAlternative
- SpeechRecognitionResult::__construct() — Method in class SpeechRecognitionResult
- StreamingRecognitionConfig::__construct() — Method in class StreamingRecognitionConfig
- StreamingRecognitionResult::__construct() — Method in class StreamingRecognitionResult
- StreamingRecognizeRequest::__construct() — Method in class StreamingRecognizeRequest
- StreamingRecognizeResponse::__construct() — Method in class StreamingRecognizeResponse
- SyncRecognizeRequest::__construct() — Method in class SyncRecognizeRequest
- SyncRecognizeResponse::__construct() — Method in class SyncRecognizeResponse
- LongRunningRecognizeMetadata::__construct() — Method in class LongRunningRecognizeMetadata
- LongRunningRecognizeRequest::__construct() — Method in class LongRunningRecognizeRequest
- LongRunningRecognizeResponse::__construct() — Method in class LongRunningRecognizeResponse
- RecognitionAudio::__construct() — Method in class RecognitionAudio
- RecognitionConfig::__construct() — Method in class RecognitionConfig
- RecognitionMetadata::__construct() — Method in class RecognitionMetadata
- RecognizeRequest::__construct() — Method in class RecognizeRequest
- RecognizeResponse::__construct() — Method in class RecognizeResponse
- SpeechContext::__construct() — Method in class SpeechContext
- SpeechGrpcClient::__construct() — Method in class SpeechGrpcClient
- SpeechRecognitionAlternative::__construct() — Method in class SpeechRecognitionAlternative
- SpeechRecognitionResult::__construct() — Method in class SpeechRecognitionResult
- StreamingRecognitionConfig::__construct() — Method in class StreamingRecognitionConfig
- StreamingRecognitionResult::__construct() — Method in class StreamingRecognitionResult
- StreamingRecognizeRequest::__construct() — Method in class StreamingRecognizeRequest
- StreamingRecognizeResponse::__construct() — Method in class StreamingRecognizeResponse
- WordInfo::__construct() — Method in class WordInfo
- AcknowledgeTaskRequest::__construct() — Method in class AcknowledgeTaskRequest
- AppEngineHttpRequest::__construct() — Method in class AppEngineHttpRequest
- AppEngineHttpTarget::__construct() — Method in class AppEngineHttpTarget
- AppEngineRouting::__construct() — Method in class AppEngineRouting
- AttemptStatus::__construct() — Method in class AttemptStatus
- CancelLeaseRequest::__construct() — Method in class CancelLeaseRequest
- CloudTasksGrpcClient::__construct() — Method in class CloudTasksGrpcClient
- CreateQueueRequest::__construct() — Method in class CreateQueueRequest
- CreateTaskRequest::__construct() — Method in class CreateTaskRequest
- DeleteQueueRequest::__construct() — Method in class DeleteQueueRequest
- DeleteTaskRequest::__construct() — Method in class DeleteTaskRequest
- GetQueueRequest::__construct() — Method in class GetQueueRequest
- GetTaskRequest::__construct() — Method in class GetTaskRequest
- LeaseTasksRequest::__construct() — Method in class LeaseTasksRequest
- LeaseTasksResponse::__construct() — Method in class LeaseTasksResponse
- ListQueuesRequest::__construct() — Method in class ListQueuesRequest
- ListQueuesResponse::__construct() — Method in class ListQueuesResponse
- ListTasksRequest::__construct() — Method in class ListTasksRequest
- ListTasksResponse::__construct() — Method in class ListTasksResponse
- PauseQueueRequest::__construct() — Method in class PauseQueueRequest
- PullMessage::__construct() — Method in class PullMessage
- PullTarget::__construct() — Method in class PullTarget
- PurgeQueueRequest::__construct() — Method in class PurgeQueueRequest
- Queue::__construct() — Method in class Queue
- RateLimits::__construct() — Method in class RateLimits
- RenewLeaseRequest::__construct() — Method in class RenewLeaseRequest
- ResumeQueueRequest::__construct() — Method in class ResumeQueueRequest
- RetryConfig::__construct() — Method in class RetryConfig
- RunTaskRequest::__construct() — Method in class RunTaskRequest
- Task::__construct() — Method in class Task
- TaskStatus::__construct() — Method in class TaskStatus
- UpdateQueueRequest::__construct() — Method in class UpdateQueueRequest
- AttributeValue::__construct() — Method in class AttributeValue
- BatchWriteSpansRequest::__construct() — Method in class BatchWriteSpansRequest
- Module::__construct() — Method in class Module
- Span::__construct() — Method in class Span
- Span_Attributes::__construct() — Method in class Span_Attributes
- Span_Link::__construct() — Method in class Span_Link
- Span_Links::__construct() — Method in class Span_Links
- Span_TimeEvent::__construct() — Method in class Span_TimeEvent
- Span_TimeEvent_Annotation::__construct() — Method in class Span_TimeEvent_Annotation
- Span_TimeEvent_MessageEvent::__construct() — Method in class Span_TimeEvent_MessageEvent
- Span_TimeEvents::__construct() — Method in class Span_TimeEvents
- StackTrace::__construct() — Method in class StackTrace
- StackTrace_StackFrame::__construct() — Method in class StackTrace_StackFrame
- StackTrace_StackFrames::__construct() — Method in class StackTrace_StackFrames
- TraceServiceGrpcClient::__construct() — Method in class TraceServiceGrpcClient
- TruncatableString::__construct() — Method in class TruncatableString
- AnnotateVideoProgress::__construct() — Method in class AnnotateVideoProgress
- AnnotateVideoRequest::__construct() — Method in class AnnotateVideoRequest
- AnnotateVideoResponse::__construct() — Method in class AnnotateVideoResponse
- Entity::__construct() — Method in class Entity
- ExplicitContentAnnotation::__construct() — Method in class ExplicitContentAnnotation
- ExplicitContentDetectionConfig::__construct() — Method in class ExplicitContentDetectionConfig
- ExplicitContentFrame::__construct() — Method in class ExplicitContentFrame
- FaceAnnotation::__construct() — Method in class FaceAnnotation
- FaceDetectionConfig::__construct() — Method in class FaceDetectionConfig
- FaceFrame::__construct() — Method in class FaceFrame
- FaceSegment::__construct() — Method in class FaceSegment
- LabelAnnotation::__construct() — Method in class LabelAnnotation
- LabelDetectionConfig::__construct() — Method in class LabelDetectionConfig
- LabelFrame::__construct() — Method in class LabelFrame
- LabelSegment::__construct() — Method in class LabelSegment
- NormalizedBoundingBox::__construct() — Method in class NormalizedBoundingBox
- ShotChangeDetectionConfig::__construct() — Method in class ShotChangeDetectionConfig
- VideoAnnotationProgress::__construct() — Method in class VideoAnnotationProgress
- VideoAnnotationResults::__construct() — Method in class VideoAnnotationResults
- VideoContext::__construct() — Method in class VideoContext
- VideoIntelligenceServiceGrpcClient::__construct() — Method in class VideoIntelligenceServiceGrpcClient
- VideoSegment::__construct() — Method in class VideoSegment
- AnnotateVideoProgress::__construct() — Method in class AnnotateVideoProgress
- AnnotateVideoRequest::__construct() — Method in class AnnotateVideoRequest
- AnnotateVideoResponse::__construct() — Method in class AnnotateVideoResponse
- BoundingBox::__construct() — Method in class BoundingBox
- FaceAnnotation::__construct() — Method in class FaceAnnotation
- FaceLocation::__construct() — Method in class FaceLocation
- LabelAnnotation::__construct() — Method in class LabelAnnotation
- LabelLocation::__construct() — Method in class LabelLocation
- SafeSearchAnnotation::__construct() — Method in class SafeSearchAnnotation
- VideoAnnotationProgress::__construct() — Method in class VideoAnnotationProgress
- VideoAnnotationResults::__construct() — Method in class VideoAnnotationResults
- VideoContext::__construct() — Method in class VideoContext
- VideoIntelligenceServiceGrpcClient::__construct() — Method in class VideoIntelligenceServiceGrpcClient
- VideoSegment::__construct() — Method in class VideoSegment
- AnnotateVideoProgress::__construct() — Method in class AnnotateVideoProgress
- AnnotateVideoRequest::__construct() — Method in class AnnotateVideoRequest
- AnnotateVideoResponse::__construct() — Method in class AnnotateVideoResponse
- Entity::__construct() — Method in class Entity
- ExplicitContentAnnotation::__construct() — Method in class ExplicitContentAnnotation
- ExplicitContentDetectionConfig::__construct() — Method in class ExplicitContentDetectionConfig
- ExplicitContentFrame::__construct() — Method in class ExplicitContentFrame
- FaceAnnotation::__construct() — Method in class FaceAnnotation
- FaceDetectionConfig::__construct() — Method in class FaceDetectionConfig
- FaceFrame::__construct() — Method in class FaceFrame
- FaceSegment::__construct() — Method in class FaceSegment
- LabelAnnotation::__construct() — Method in class LabelAnnotation
- LabelDetectionConfig::__construct() — Method in class LabelDetectionConfig
- LabelFrame::__construct() — Method in class LabelFrame
- LabelSegment::__construct() — Method in class LabelSegment
- NormalizedBoundingBox::__construct() — Method in class NormalizedBoundingBox
- ShotChangeDetectionConfig::__construct() — Method in class ShotChangeDetectionConfig
- VideoAnnotationProgress::__construct() — Method in class VideoAnnotationProgress
- VideoAnnotationResults::__construct() — Method in class VideoAnnotationResults
- VideoContext::__construct() — Method in class VideoContext
- VideoIntelligenceServiceGrpcClient::__construct() — Method in class VideoIntelligenceServiceGrpcClient
- VideoSegment::__construct() — Method in class VideoSegment
- AnnotateFileResponse::__construct() — Method in class AnnotateFileResponse
- AnnotateImageRequest::__construct() — Method in class AnnotateImageRequest
- AnnotateImageResponse::__construct() — Method in class AnnotateImageResponse
- AsyncAnnotateFileRequest::__construct() — Method in class AsyncAnnotateFileRequest
- AsyncAnnotateFileResponse::__construct() — Method in class AsyncAnnotateFileResponse
- AsyncBatchAnnotateFilesRequest::__construct() — Method in class AsyncBatchAnnotateFilesRequest
- AsyncBatchAnnotateFilesResponse::__construct() — Method in class AsyncBatchAnnotateFilesResponse
- BatchAnnotateImagesRequest::__construct() — Method in class BatchAnnotateImagesRequest
- BatchAnnotateImagesResponse::__construct() — Method in class BatchAnnotateImagesResponse
- Block::__construct() — Method in class Block
- BoundingPoly::__construct() — Method in class BoundingPoly
- ColorInfo::__construct() — Method in class ColorInfo
- CropHint::__construct() — Method in class CropHint
- CropHintsAnnotation::__construct() — Method in class CropHintsAnnotation
- CropHintsParams::__construct() — Method in class CropHintsParams
- DominantColorsAnnotation::__construct() — Method in class DominantColorsAnnotation
- EntityAnnotation::__construct() — Method in class EntityAnnotation
- FaceAnnotation::__construct() — Method in class FaceAnnotation
- FaceAnnotation_Landmark::__construct() — Method in class FaceAnnotation_Landmark
- Feature::__construct() — Method in class Feature
- GcsDestination::__construct() — Method in class GcsDestination
- GcsSource::__construct() — Method in class GcsSource
- Image::__construct() — Method in class Image
- ImageAnnotationContext::__construct() — Method in class ImageAnnotationContext
- ImageAnnotatorGrpcClient::__construct() — Method in class ImageAnnotatorGrpcClient
- ImageContext::__construct() — Method in class ImageContext
- ImageProperties::__construct() — Method in class ImageProperties
- ImageSource::__construct() — Method in class ImageSource
- InputConfig::__construct() — Method in class InputConfig
- LatLongRect::__construct() — Method in class LatLongRect
- LocationInfo::__construct() — Method in class LocationInfo
- NormalizedVertex::__construct() — Method in class NormalizedVertex
- OperationMetadata::__construct() — Method in class OperationMetadata
- OutputConfig::__construct() — Method in class OutputConfig
- Page::__construct() — Method in class Page
- Paragraph::__construct() — Method in class Paragraph
- Position::__construct() — Method in class Position
- Property::__construct() — Method in class Property
- SafeSearchAnnotation::__construct() — Method in class SafeSearchAnnotation
- Symbol::__construct() — Method in class Symbol
- TextAnnotation::__construct() — Method in class TextAnnotation
- TextAnnotation_DetectedBreak::__construct() — Method in class TextAnnotation_DetectedBreak
- TextAnnotation_DetectedLanguage::__construct() — Method in class TextAnnotation_DetectedLanguage
- TextAnnotation_TextProperty::__construct() — Method in class TextAnnotation_TextProperty
- Vertex::__construct() — Method in class Vertex
- WebDetection::__construct() — Method in class WebDetection
- WebDetectionParams::__construct() — Method in class WebDetectionParams
- WebDetection_WebEntity::__construct() — Method in class WebDetection_WebEntity
- WebDetection_WebImage::__construct() — Method in class WebDetection_WebImage
- WebDetection_WebLabel::__construct() — Method in class WebDetection_WebLabel
- WebDetection_WebPage::__construct() — Method in class WebDetection_WebPage
- Word::__construct() — Method in class Word
- AuditData::__construct() — Method in class AuditData
- CancelOperationRequest::__construct() — Method in class CancelOperationRequest
- DeleteOperationRequest::__construct() — Method in class DeleteOperationRequest
- GetOperationRequest::__construct() — Method in class GetOperationRequest
- ListOperationsRequest::__construct() — Method in class ListOperationsRequest
- ListOperationsResponse::__construct() — Method in class ListOperationsResponse
- Operation::__construct() — Method in class Operation
- OperationsGrpcClient::__construct() — Method in class OperationsGrpcClient
- BadRequest::__construct() — Method in class BadRequest
- BadRequest_FieldViolation::__construct() — Method in class BadRequest_FieldViolation
- DebugInfo::__construct() — Method in class DebugInfo
- Help::__construct() — Method in class Help
- Help_Link::__construct() — Method in class Help_Link
- LocalizedMessage::__construct() — Method in class LocalizedMessage
- PreconditionFailure::__construct() — Method in class PreconditionFailure
- PreconditionFailure_Violation::__construct() — Method in class PreconditionFailure_Violation
- QuotaFailure::__construct() — Method in class QuotaFailure
- QuotaFailure_Violation::__construct() — Method in class QuotaFailure_Violation
- RequestInfo::__construct() — Method in class RequestInfo
- ResourceInfo::__construct() — Method in class ResourceInfo
- RetryInfo::__construct() — Method in class RetryInfo
- Status::__construct() — Method in class Status
- Color::__construct() — Method in class Color
- Date::__construct() — Method in class Date
- LatLng::__construct() — Method in class LatLng
- Money::__construct() — Method in class Money
- PostalAddress::__construct() — Method in class PostalAddress
- TimeOfDay::__construct() — Method in class TimeOfDay